Prisijungimas prie BSS API ir tokenų atnaujinimas

Autentifikavimas

Norint pradėti naudoti BSS API, reikalingi prisijungimo duomenys. Prisijungimui reikalingą informaciją pateikia BSS konsultantai. Jeigu šių duomenų dar neturite, kreipkitės į BSS konsultantus. Gavus prisijungimo duomenis, pirmiausia reikia autentifikuotis ir gauti prieigos raktus – AccessToken ir RefreshToken.

Prisijungimas prie API – Sign in with credentials

Pirmam prisijungimui prie API naudojamas POST – Sign in with credentials metodas. Užklausoje perduodama ši informacija:

{
  "username": "A",
  "password": "A",
  "environmentId": 1,
  "companyId": 1
}
Laukas Paaiškinimas
username API prisijungimo naudotojo vardas.
password API prisijungimo slaptažodis.
environmentId BSS aplinkos, prie kurios jungiama integracija, portfelio numeris.
companyId Įmonės, su kurios duomenimis bus dirbama per API, identifikatorius (visada reikšmė 2)

Kas gaunama prisijungus?

Sėkmingai prisijungus gaunami du prieigos raktai:

Reikšmė Kam naudojama Galiojimas
AccessToken Naudojamas siunčiant API užklausas. 20 minučių
RefreshToken Naudojamas naujam AccessToken gauti. 1 dieną

Ką tai reiškia praktiškai?Prisijungimo metu gauto AccessToken negalima naudoti neribotą laiką. Po 20 minučių jo galiojimas baigiasi. Tačiau kas 20 minučių iš naujo jungtis su username ir password nereikia. Kol galioja RefreshToken, naudojamas Refresh access token metodas ir gaunamas naujas AccessToken.

Trumpai: prisijungiame → gauname AccessToken ir RefreshToken → su AccessToken siunčiame API užklausas → AccessToken pasibaigia → su RefreshToken gauname naują AccessToken → dirbame toliau.

AccessToken naudojimas API užklausose

Gautas AccessToken turi būti perduodamas autentifikuotose API užklausose HTTP antraštėje:

Authorization: Bearer {accessToken}

AccessToken atnaujinimas – Refresh access token

Pasibaigus AccessToken galiojimui naudojamas POST /:refresh – Refresh access token metodas. Užklausoje perduodamas turimas RefreshToken:

{
  "refreshToken": "..."
}

Jeigu RefreshToken dar galioja, gaunamas naujas AccessToken, kuris toliau naudojamas API užklausoms. Pasibaigus ir RefreshToken galiojimui, reikia autentifikuotis iš naujo naudojant Sign in with credentials metodą.

Atsijungimas – Sign out & invalidate access token

Kai prieiga prie API turi būti užbaigta, naudojamas DELETE – Sign out & invalidate access token metodas. Jis skirtas naudojamo prieigos rakto galiojimui panaikinti.