Autorizace zákazníka
Metoda se používá k autorizaci klienta v systému. Odpověď vrací přístupový token a obnovovací token, které jsou nutné pro další požadavky na rozhraní API.
Popis koncového bodu
Metoda slouží k autorizaci klienta v systému. Odpověď vrací přístupový token a obnovovací token, které jsou vyžadovány pro další požadavky na rozhraní API.
Žádost: Autorizace
URL:
POST /auth/sign-in
Štítky:
auth
Popis: Autorizace klienta pomocí pověření (e-mail, jednorázové heslo nebo běžné heslo).
Příklad požadavku (cURL):
curl -X 'POST' \
'https://api.client.nbcgate.tech/auth/sign-in' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"email": "[email protected]",
"otp": "123456",
"password": "yourpassword"
}'
Tělo žádosti:
otp
string
Ne
Jednorázové heslo (pokud se používá)
123456
password
string
Ne
Heslo uživatele
yourpassword
Poznámka: V závislosti na použité metodě autorizace nezapomeňte zadat buď
otp
, neboheslo
.
Příklad úspěšné reakce:
Kód odpovědi: 200 OK
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"refreshToken": "dXNlcl9yZWZyZXNoX3Rva2Vu..."
}
Popis reakce:
token
string
Přístupový token používaný pro autorizaci v rozhraní API
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
refreshToken
string
Token pro aktualizaci přístupu
dXNlcl9yZWZyZXNoX3Rva2Vu...
Kódy odpovědí:
200
Úspěšná autorizace
Správné pověření
400, 404
Neplatný dotaz nebo nenalezený uživatel
Chyba v parametrech požadavku
500
Interní chyba serveru
Problémy na straně serveru
default
Neznámá chyba
Je třeba objasnit důvody
Last updated