Headers

External Commerce API isteklerinde authentication, JSON body, idempotency ve request correlation için standart HTTP header alanları kullanılır.

HeaderGerekli olduğu durumAçıklama
AuthorizationAuthenticated endpointlerBearer API credential
AcceptÖnerilirapplication/json
Content-TypeJSON body bulunan write işlemleriapplication/json
Idempotency-Keyİlgili write endpointleriAynı mantıksal işlemin güvenli retry edilmesini sağlar
X-BYNovax-Request-IdOpsiyonelİ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.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Accept

API response'ları JSON formatında olduğundan Accept: application/json kullanmanız önerilir.

Accept: application/json

Content-Type

POST, PATCH veya PUT isteğinde JSON body gönderiyorsanız Content-Type header'ını application/json olarak ayarlayın.

Content-Type: application/json

Idempotency-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