Yetkilendirme
Basic kimlik doğrulama, entegratör başlıkları ve hız sınırı.
Basic kimlik doğrulama
Her istek Authorization: Basic base64(apiKey:apiSecret) taşır. apiKey herkese görünür ve loglanabilir; apiSecret gizlidir ve yalnız üretildiği anda bir kez gösterilir. Partner panelindeki Token alanı bu base64(apiKey:apiSecret) değerinin kendisidir; başlığa doğrudan yazılabilir.
printf '%s:%s' "$API_KEY" "$API_SECRET" | base64Anahtarın öneki ortamını söyler: ck_live_ canlı, ck_test_ test ortamı. Yanlış ortama gönderilen anahtar 401 environment_mismatch alır; her yanıttaki X-Api-Environment başlığı hangi ortama konuştuğunuzu gösterir.
Her anahtar çifti tek bir işletmeye bağlıdır. İşletmeyi ve dikeyi (restaurant ya da store) anahtar belirler; istekte işletme kimliği gönderilmez. Yanıtlardaki merchantId işletmenin kimliğidir. Bu kimlik banka ya da ödeme kuruluşunun üye işyeri numarası değildir; platformdaki işletme kimliğinizdir.
apiSecret sızarsa partner panelinden Yenile ile döndürün; eski secret anında geçersizleşir. Sızmış bir secret, işletmenin kataloğunu ve siparişlerini üçüncü bir tarafa açık bırakır.Entegratör başlıkları
| Alan | Tip | Açıklama |
|---|---|---|
X-Integratorzorunlu | string | Kasa yazılımını geliştiren firmanın adı. 1–30 karakter; Türkçe karakter içermeyen harf, rakam ve boşluk (örnek: Ornek POS). Kendi yazılımınızsa firma adınızı yazın. Eksik ya da geçersizse 403 integrator_header_required döner. |
X-Operator | string | İsteğe bağlı. Kasadaki kullanıcının kimliği: en çok 64 karakter; harf, rakam ve . _ : -. E-posta adresi gönderilmez. Gelmezse kayda otomatik yazılır. Geçersizse 400 invalid_operator döner. |
X-Request-Id | string | İsteğe bağlı. Gönderirseniz baştaki ve sondaki boşluklar atılır, değer en çok 64 karaktere kırpılır ve yanıtta aynen geri döner. Göndermezseniz üretilir. |
X-Integrator ve X-Operator değerleri işletmenin sipariş geçmişinde ve denetim kaydında görünür: bir işlemi hangi yazılımın ve hangi kasa kullanıcısının yaptığı bu iki alandan okunur.
Hız sınırı
Servis grubu ve anahtar başına 10 saniyede 50 istek. Sayım uç başına değil grup başınadır. Sipariş ve mağaza uçları katalogdan ayrı gruptadır; büyük bir katalog yüklemesi sipariş kabulünü engellemez. Grupların uçları ve diğer sınırlar için Servis Limitleri sayfasına bakın.
Kalan bütçe, kimlik doğrulamasına ulaşan her yanıtta (304 ve hata yanıtları dahil) RateLimit-Limit, RateLimit-Remaining ve RateLimit-Reset başlıklarıyla bildirilir. Aşımda 429 ve Retry-After döner.
Yetki hataları
| Alan | Tip | Açıklama |
|---|---|---|
401 | unauthorized | Anahtar ya da parola geçersiz, anahtar kapalı ya da işletme bağı kopmuş. |
401 | environment_mismatch | Anahtar başka ortama ait (ck_test_ canlıda ya da ck_live_ test ortamında); ileti doğru adresi verir. |
403 | integrator_header_required | X-Integrator başlığı eksik ya da geçersiz. |
400 | invalid_operator | X-Operator değeri geçersiz. |
404 | not_found | Kayıt yok ya da bu işletmeye ait değil. İki durumda yanıt aynıdır. |
404 | not_available_for_vertical | Uç bu işletmenin dikeyinde yok. İleti hangi dikeyde bulunduğunu söyler. |
429 | too_many_requests | Hız sınırı aşıldı; reason sınırın hangisi olduğunu söyler, Retry-After kadar bekleyin. |
Başka işletmenin kaydı 403 değil 404 döner: 403 yanıtı kaydın var olduğunu doğrulardı. Tam liste için Hata Kodları sayfasına bakın.