Headers
External Commerce API isteklerinde authentication, JSON body, idempotency ve request correlation için standart HTTP header alanları kullanılır.
| Header | Gerekli olduğu durum | Açıklama |
|---|---|---|
| Authorization | Authenticated endpointler | Bearer API credential |
| Accept | Önerilir | application/json |
| Content-Type | JSON body bulunan write işlemleri | application/json |
| Idempotency-Key | İlgili write endpointleri | Aynı mantıksal işlemin güvenli retry edilmesini sağlar |
| X-BYNovax-Request-Id | Opsiyonel | İstemci correlation değeri |
Authorization header
API credential Authorization header içerisinde Bearer şemasıyla gönderilir. Credential'ı query string veya body içerisinde göndermeyin.
Authorization: Bearer bnx_live_xxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxAccept
API response'ları JSON formatında olduğundan Accept: application/json kullanmanız önerilir.
Accept: application/jsonContent-Type
POST, PATCH veya PUT isteğinde JSON body gönderiyorsanız Content-Type header'ını application/json olarak ayarlayın.
Content-Type: application/jsonIdempotency-Key
Write endpoint contract'ı Idempotency-Key gerektiriyorsa her yeni mantıksal işlem için benzersiz bir key üretin.
Network timeout sonrası aynı işlemi tekrar gönderiyorsanız aynı key'i kullanın. Farklı business işlemi için yeni key kullanın.
Credential güvenliği
- Credential'ı browser-side JavaScript'e koymayın.
- Credential'ı URL içerisinde taşımayın.
- Tam credential değerini loglara yazmayın.
- Secret manager veya environment variable kullanın.
Tam header örneği
Authorization: Bearer bnx_live_xxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Accept: application/json
Content-Type: application/json
Idempotency-Key: inventory-7314-update-001