Kimlik doğrulama

Noyax API, JWT biçiminde access token kullanır. Token’ı API anahtarınızla Noyax auth servisinden alırsınız ve her isteğin Authorization header’ında gönderirsiniz.

Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImFwaSIs...

Akış

Token almak

string

gerekli

Kuruluş adınız. Noyax tarafından verilir.

string

gerekli

API anahtarınız.

curl -X POST https://app.noyax.com/services/bb_auth_service/api/ApiAuth/login \
  -H "Content-Type: application/json" \
  -d '{ "OrgName": "KURULUS_ADINIZ", "ApiKey": "API_ANAHTARINIZ" }'

{
  "Data": {
    "AccessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImFwaSIs...",
    "RefreshToken": "q3Jv1mYt8Rk0bXw2LzH5nD7sPfA9cGe4..."
  },
  "Success": true,
  "Message": null
}

Bilgiler hatalıysa ya da API lisansınızın süresi dolmuşsa auth servisi 401 döner (Invalid API credentials., ApiKey expired.).

Token’ı yenilemek

Access token kısa ömürlüdür (dakikalar mertebesinde). Süresi dolduğunda API şu yanıtı döner:

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired"

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    { "Code": "0102", "Message": "Token has expired. Obtain a new token using the refresh token." }
  ]
}

Bu durumda eski access token ve refresh token ile yeni bir çift alın:

curl -X POST https://app.noyax.com/services/bb_auth_service/api/ApiAuth/refresh \
  -H "Content-Type: application/json" \
  -d '{ "AccessToken": "SURESI_DOLMUS_TOKEN", "RefreshToken": "REFRESH_TOKEN" }'

Yanıt, login yanıtıyla aynı yapıdadır.

Her login ve refresh işlemi yeni bir refresh token üretir ve öncekini geçersiz kılar. Bir API anahtarının aynı anda yalnızca bir geçerli refresh token’ı olur. Aynı anahtarı birden fazla sunucu ya da işlem kullanıyorsa token’ı tek bir yerde yönetin ve paylaşın. Aksi halde bir işlemin yenilemesi diğerinin refresh token’ını geçersiz kılar.

Önerilen uygulama

Token’ı bellekte ya da paylaşılan bir cache’te tutun; her istekte login olmayın.
Token’ın exp claim’ine bakarak süresi dolmadan kısa süre önce yenileyin ya da 401 invalid_token aldığınızda bir kez yenileyip isteği tekrarlayın.
Refresh başarısız olursa (Invalid refresh token.) yeniden login olun.

Token içeriği

Access token, API anahtarınıza tanımlı bilgileri taşır. Bu bilgiler token alınırken belirlenir:

Claim	Anlamı
`P`	Modül yetkileri. Bkz. Yetkiler
`ARC`	Günlük istek limiti. Bkz. Limitler
`exp`	Token’ın geçerlilik bitişi (Unix zamanı)

Anahtarınızın yetkileri ya da günlük limiti değiştirilirse, değişiklik yeni token aldığınızda geçerli olur.

Başlarken

Temel kavramlar

Modüller

Sürüm notları

Akış

Token almak

Token’ı yenilemek

Önerilen uygulama

Token içeriği

​Akış

​Token almak

​Token’ı yenilemek

​Önerilen uygulama

​Token içeriği

Akış

Token almak

Token’ı yenilemek

Önerilen uygulama

Token içeriği