İçeriğe geç
clearance.rest

Kimlik doğrulama

Numbers, Emails ve Captchas’a giden her istek, projenizin API anahtarı ile doğrulanır. Anahtar X-API-Key header’ında gönderilir.

curl https://api.clearance.rest/numbers/list \
  -H "X-API-Key: cr_live_..."

Eksik ya da geçersiz anahtar 401 döndürür.

Anahtarınız

Bölüm başlığı “Anahtarınız”
  • Anahtarlar cr_live_ ile başlar.
  • Her projenin bir anahtarı vardır. Console’da projenin sayfasında görünür, oradan yenilenebilir.
  • Anahtar projeyi tanımlar; dolayısıyla bir isteğin hangi numaraları ve posta kutularını görebileceğini de belirler. İki proje birbirinin numaralarını asla görmez.
  • Projenin id’si bir anahtar değildir ve anahtar olarak asla kabul edilmez.

Anahtarı sunucunuzda tutun. Tarayıcıya ya da mobil uygulamaya koymayın.

Header gönderemeyen istemciler

Bölüm başlığı “Header gönderemeyen istemciler”

Bir istemci özel header ayarlayamıyorsa (örneğin doğrudan açılan bir link), anahtarı bunun yerine api_key query parametresi olarak verin:

https://api.clearance.rest/emails/attachments/1783459025000_1_invoice.pdf?api_key=cr_live_...

Yapabildiğiniz her yerde header’ı tercih edin: query string’ler log’lara düşer.

API anahtarı istemeyen endpoint’ler

Bölüm başlığı “API anahtarı istemeyen endpoint’ler”

Birkaç endpoint başka sistemler ya da bir tarayıcı tarafından çağrılır ve arayanı başka bir yolla tanır. Bunlar için API anahtarınıza gerek yoktur:

  • Claim socket (GET /numbers/providers/mobile/claim/socket) bunun yerine tek kullanımlık bir ticket alır. Tarayıcı WebSocket’i header gönderemez ve anahtarınız tarayıcıya ulaşmamalıdır; bu yüzden backend’iniz anahtarı, 60 saniyelik bir bilet ile POST /numbers/providers/mobile/claim/ticket üzerinden değiştirir. Bkz. Mobil numaralar.
  • SIM Bridge indirme (GET /numbers/providers/mobile/download_apk) açıktır; hiçbir şey kurulu olmayan bir telefon uygulamayı çekebilsin diye.

Anahtarı yenileme

Bölüm başlığı “Anahtarı yenileme”

Console’da bir anahtarı yenilemek eskisini geçersiz kılar. Değişiklik yaklaşık 30 saniye içinde tüm servislere ulaşır; anahtarı kullanan istemcileri vakit geçirmeden güncelleyin.

SDK’lar

Bölüm başlığı “SDK’lar”

Node.js ve PHP SDK’ları anahtarı CLEARANCE_REST_API_KEY ortam değişkeninden okur ve header’ı sizin yerinize gönderir.