Ana içeriğe atla
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.

Akış

Token almak

string
gerekli
Kuruluş adınız. Noyax tarafından verilir.
string
gerekli
API anahtarınız.
Bilgiler hatalıysa ya da API lisansınızın süresi dolmuşsa auth servisi 401 döner (Invalid API credentials., ApiKey expired.).
Auth servisinin yanıtı Data, Success ve Message alanlarından oluşur; Noyax API yanıtlarındaki ResultCode ve Errors alanları burada yoktur.
Aynı OrgName ve ApiKey ile tekrar login olduğunuzda, süresi dolmak üzere değilse aynı token döner. Bu yüzden her istekten önce login olmanız sorun değildir.

Token’ı yenilemek

Access token 20 dakika geçerlidir. Süresi dolduğunda API şu yanıtı döner:
Bu durumda yeniden login olun ya da eski access token ve refresh token ile yeni bir çift alın:
Yanıt, login yanıtıyla aynı yapıdadır.
Her refresh işlemi yeni bir refresh token üretir ve öncekini geçersiz kılar. Aynı anahtarı birden fazla sunucu ya da işlem kullanıyorsa refresh yerine yeniden login olmak en basit yoldur.

Önerilen uygulama

İki yoldan birini seçin:
  • Her istekte login olun. En basit yoldur; login, süresi dolmamış token’ı tekrar döndürür.
  • Token’ı saklayıp tekrar kullanın. Access token bir JWT’dir; geçerlilik bitişi exp claim’inde (Unix zamanı) yazar. Süresi dolmadan kısa süre önce ya da 401 aldığınızda yeniden login olun (veya refresh edin) ve isteği tekrarlayın.
Anahtarınızın yetkileri ya da limitleri değiştirilirse, değişiklik yeni token aldığınızda geçerli olur.