Meetod: GET /keyLogin/
Teenus autentib REST API kasutaja API võtme alusel ja tagastab ligipääsutokeni, mida kasutatakse REST teenuste päringutes.
Teenuse kasutamine
Uue lepingulise partneri loomisel või juba olemasoleva puhul tuleb luua uus API võti. REST teenuste kasutamisel tuleb esmalt kasutada API võtmega autentimise teenust /keyLogin/. Teenus tagastab access_token väärtuse ja tokeni tüübi. Saadud token lisatakse järgnevate REST teenuste päringutesse autentimiseks.
Täpsem juhis api võtme loomiseks: API võtmete lisamine REST teenustele | Abiinfo
Päise parameetrid
| Parameeter | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
| apiKey | string | Kohustuslik | Autentimiseks kasutatav API võti. |
Vastuse skeem
KeyLoginResponse
| Väli | Tüüp | Kirjeldus |
|---|---|---|
| access_token | string | Kohustuslik. Ligipääsutoken, mida kasutatakse järgnevate REST teenuste päringutes. |
| token_type | string | Kohustuslik. Tokeni tüüp. Tavaliselt kasutatakse seda koos ligipääsutokeniga autentimise päises. |
Vastused
200 OK
Edukas autentimine — teenus tagastab ligipääsutokeni ja tokeni tüübi.
{
"access_token": "eyJhbGciOi...",
"token_type": "bearer"
}
404 Not Found
API võtit ei leitud või autentimine ei õnnestunud. Vastus kasutab skeemi CustomValidationError.
{
"message": "API key was not found",
"code": 4041,
"id": "API_KEY_NOT_FOUND"
}
422 Validation Error
Vigane päring — kohustuslik päise parameeter puudub või ei vasta valideerimisreeglitele. Vastus kasutab skeemi HTTPValidationError.
{
"detail": [
{
"loc": ["header", "apiKey"],
"msg": "Field required",
"type": "missing"
}
]
}
JSON Schema
{
"KeyLoginResponse": {
"type": "object",
"required": [
"access_token",
"token_type"
],
"properties": {
"access_token": {
"type": "string",
"description": "Ligipääsutoken"
},
"token_type": {
"type": "string",
"description": "Tokeni tüüp"
}
}
}
}