Kimlik Doğrulama V1

Bulbulustur API erişiminde X-Api-Key ve X-Api-Secret HTTP başlıkları kullanılır. Bu sayfa kimlik doğrulama akışını, mağaza bağlamını ve erişim hatalarını açıklar.

Kimlik Doğrulama

API Key ve API Secret

Bulbulustur Developer API, mağazaya tanımlanmış API Key ve API Secret bilgileriyle kimlik doğrular. Korunan her HTTP isteğinde iki değer ayrı header olarak gönderilir.

Gerekli header'lar

X-Api-Keystring · Zorunlu

Mağaza API anahtarı. İstek başına tek değer; maksimum 100 karakter.

X-Api-Secretstring · Zorunlu

Anahtara ait gizli değer. İstek başına tek değer; maksimum 1024 karakter.

Header'ları HTTPS üzerinden gönderin. API Secret'ı istemci tarafı JavaScript'e, mobil uygulama paketine veya loglara koymayın; sunucu tarafında saklayın.

Token yok

Bu akış JWT veya OAuth erişim tokenı üretmez. HMAC imzası da kullanılmaz. Her API isteğinde aynı iki header gönderilir.

cURLKorunan API isteği

curl --request GET \
  'https://developers.bulbulustur.com/api/store' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'X-Api-Secret: YOUR_API_SECRET' \
  --header 'Accept: application/json'

Örnek değerleri kendi mağaza API kimlik bilgilerinizle değiştirin.

Kimlik Bilgilerini Test Etme

POST /api/Credential/authenticate

Kimlik bilgilerinizi ve erişim politikasını kontrol etmek için POST /api/Credential/authenticate endpointini kullanın. Bu işlem kimlik doğrulama testi yapar; yeni anahtar, JWT veya oturum tokenı üretmez.

İstek

Gövdede parametre gerekmez. X-Api-Key ve X-Api-Secret header'ları zorunludur.

Başarılı yanıt alanları

isAuthenticatedboolean

Doğrulama sonucudur.

storeIdinteger

Kimlik bilgilerinin bağlı olduğu mağaza kimliği.

apiScopestring

Anahtarın kapsam bilgisi.

allowedIpsstring

Tanımlanmış IP izin bilgisi; null olabilir.

expiresAtdate-time

Geçerlilik sonu; kaynak kaydına bağlıdır.

İstek limiti

Bu yol için sabit pencerede dakikada 20 istek/IP uygulanır. Ayrıntılar için İstek Limitleri sayfasına bakın.

cURLPOST /api/Credential/authenticate

curl --request POST \
  'https://developers.bulbulustur.com/api/Credential/authenticate' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'X-Api-Secret: YOUR_API_SECRET' \
  --header 'Accept: application/json'

JSON · 200 OKŞematik örnek

{
  "isAuthenticated": true,
  "message": "Kimlik Doğrulama Başarılı",
  "storeId": 123,
  "apiScope": "read",
  "allowedIps": null,
  "expiresAt": null
}

Kimlikler ve kapsam temsili; gerçek yanıt ilgili API kaydından gelir. Secret yanıtlanmaz.

Erişim Kontrolleri ve Hatalar

401 · 403 · IP izinleri

Her korunan API çağrısı middleware tarafından doğrulanır. API anahtarı mağaza ve şirket kimliğiyle ilişkilendirilir; varsa izin verilen IP'ler ve API kapsamı kontrol edilir. Sandbox anahtarları için yanıta X-Bulbulustur-Sandbox: true header'ı eklenebilir.

Doğrulama hata durumları

Durum	Koşul	Çözüm
`400`	Test endpointinde eksik/geçersiz biçimli header	İki header'ı da doğru gönderin
`401`	Normal endpointte eksik header; test endpointinde geçersiz kimlik bilgileri	Key/Secret değerlerini kontrol edin
`403`	Normal endpointte geçersiz kimlik bilgileri veya IP/kapsam izni reddi	Mağaza API yetkilerini ve IP izinlerini kontrol edin
`429`	İstek limiti aşıldı	İstekleri yavaşlatın

Middleware hata yanıtlarında success: false ve message alanlarını içeren kısa JSON nesnesi döndürür. Bunlar Result modelinin bütün alanlarını içermez.

Yanıt mesajlarını sabit hata kodu olarak ayrıştırmayın. HTTP statüsü ve varsa açıklayıcı mesajı birlikte değerlendirin; daha fazla bilgi için Hata Kodları bölümüne bakın.

JSON · 401Şematik middleware yanıtı

{
  "success": false,
  "message": "X-Api-Key ve X-Api-Secret gereklidir."
}

JSON · 403IP erişim reddi

{
  "success": false,
  "message": "IP adresi için erişim izni yok."
}