Перейти до основного вмісту

Вхід по email/пароль

Запит токену для авторизації

URI: /api/v2/authenticate

Метод використовується на початку зміни для авторизації за логіном і паролем від CashDesk. Для використання даного запиту потрібно пройти реєстрацію на сайті.

Запит виконується методом POST у json форматі з даними.

⚠️ Запит повинен містити заголовки Accept: application/json та Content-Type: application/json

У відповідь на даний запит ви отримаєте тимчасовий API токен (OAuth) у форматі Authorization: Bearer.

Після успішної авторизації в особистому кабінеті, вам необхідно згенерувати постійний API ключ.

Параметри запиту

Ім'яТипОбов'язковийОпис
emailstringТакЕлектронна пошта співробітника (логін для авторизації в CashDesk)
passwordstringТакПароль співробітника для авторизації в CashDesk

Приклад запиту

Запит: /api/v2/authenticate
{
"email": "[email protected]",
"password": "secret"
}

Параметри відповіді

Ім'яТипОпис
active_rrobooleanКористувач має активні каси
developer_idintegerНазва платформи або компанії
opened_shiftintegerВідкрита зміна
tokenstringТимчасовий токен авторизації
token_expires_atstringСтрок валідності токену
userobjectПараметри користувача
user.full_namestringПовне ім’я користувача
user.uuidstringУнікальний ідентифікатор користувача
user.emailstringЕлектронна пошта користувача
user.edrpoustringНомер ЄДРПОУ користувача
user.drfostringРеєстраційний номер облікової картки платника податків користувача
user.last_onlinestringДата останнього запиту до сервера поточним користувачем
user.subject_key_idstringПублічний ключ КЕП користувача

Приклад успішної відповіді

Успішна авторизація

200 OK

Відповідь: /api/v2/authenticate
{
"active_rro": false,
"developer_id": null,
"opened_shift": "4000055255",
"token": "Bearer eyJ0eXAiOiJKV1Q....",
"token_expires_at": "08.07.2023 11:25",
"user": {
"full_name": "Іванов Іван Іванович",
"uuid": "67***49dd-bcc7-e4631977a386",
"email": "[email protected]",
"edrpou": "34***362",
"drfo": "103***2014",
"last_online": "11-08-2020 17:15:31",
"subject_key_id": "88b920a191b2402e86f5f***f78735b0d9734b7266b80f156",
"signature": {
"serial": "14F***0700000000000000000000000000000001",
"cert_end_data": "15.11.2023"
}
}
}