Authorization/Login
URI: /account/login/
Метод використовується на початку зміни для авторизації за логіном і паролем від Skarb Cloud.
Запит виконується методом POST з тілом запиту у json форматі.
Заголовки
Запит обов'язково повинен мати заголовок Content-Type: application/json
, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.
Для підтвердження запиту користувача API необхідно передавати заголовок API-Key
.
Параметри запиту
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
string | Так | Електронна пошта співробітника (логін для авторизації в Skarb Cloud) | |
password | string | Так | Пароль співробітника для авторизації в Skarb Cloud |
Приклад запиту
Запит: /account/login/
{
"email": "[email protected]",
"password": "secret"
}
Параметри відповіді
Ім'я | Тип | Опис |
---|---|---|
data | object | Дані авторизації |
data.token | string | Токен користувача для авторизації |
data.url | string | Посилання для авторизації в eHealth |
Приклад успішної відповіді
200 OK
Успішна відповідь: /account/login/
{
"data": {
"token": "97jJdHs9vkl9TvfkDl0n6VY6QgFRVQQt",
"url": "...url for eHealth authorizitation..."
}
}
Приклади неуспішних відповідей
Некоректний email
422 Unprocessable Entity (WebDAV) (RFC 4918)
Неуспішна відповідь: /account/login/
{
"errors": {
"email": "not found"
}
}
Невірний пароль
422 Unprocessable Entity (WebDAV) (RFC 4918)
Відповідь: /account/login/
{
"errors": {
"password": "is not correct"
}
}
Помилка ліцензії
422 Unprocessable Entity (WebDAV) (RFC 4918)
Відповідь: /account/login/
{
"errors": {
"license": "employee fired or not active"
}
}