Існує 2 способи авторизації користувача в API сheckbox:
1 активний касир може мати не більше 10 діючих токенів. Після отримання нового токену, старі - видаляються автоматично. У разі отримання вами помилки виду:
Невірний токен доступу
- необхідно отримати і використовувати новий токен.
Для отримання токену доступу потрібно виконати запит /api/v1/cashier/signinPinCode та вказати ключ ліцензії каси, а у тілі запиту - пінкод касира (ці дані можна знайти у відповідних розділах особистого кабінету).
У відповідь ви отримаєте jwt
токен авторизації, підставляючи який у заголовки запитів інших методів зможете їх використовувати від імені касира, яким була виконана авторизація.
Кожного разу при новій авторизації - ви будете отримувати новий токен доступу (старі токени залишаються активними). Для деактивації токену необхідно виконати деактивацію методом /api/v1/cashier/signout із токеном, який ви хочете деактивувати.
accept: application/json
X-Client-Name: <назва інтеграції (обов`язково)>
X-Client-Version: <версія інтеграції (обов`язково)>
X-License-Key: <ключ ліцензії каси (обов`язково)>
Content-Type: application/json
{
"pin_code": "<пінкод касира>"
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/cashier/signinPinCode' \ -H 'accept: application/json' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version' \ -H 'X-License-Key: test3a544a54373a9cb3f2711111' \ -H 'Content-Type: application/json' \ -d '{ "pin_code": "2802811111"}'
{
"type": "bearer",
"token_type": "bearer",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiODVmOTI3YWMtY2RjMC00ZmIxLTgyYjctZDc4MmM1MTM0Y2Q3Iiwic3ViIjoiMDRkYTQwYWEtZTI4ZS00MmI3LThkNTEtNmNiNmVlODAwMjQ1IiwibmJmIjoxNjk5MDAwOTQyLCJpYXQiOjE2OTkwMDA5NDJ9.yNuS5e7ox3-_a7p2DI5OqwpYM7mVqIAkw1111111111"
}
Для отримання токену доступу потрібно виконати запит /api/v1/cashier/signin та вказати ЛОГІН та ПАРОЛЬ касира (пароль касира вказувався при реєстрації).
Для тестового касира пароль - це його логін.
Якщо ви не пам'ятаєте пароль касира, перейдіть в особистий кабінет checkbox → Касири → натисніть ··· навпроти касира → Редагувати → введіть новий пароль касира → натисніть Зберегти.
У відповідь ви отримаєте jwt
токен авторизації, підставляючи який у заголовки запитів інших методів зможете їх використовувати від імені касира, яким була виконана авторизація.
Кожного разу при новій авторизації - ви будете отримувати новий токен доступу (старі токени залишаються активними). Для деактивації токену необхідно виконати деактивацію методом /api/v1/cashier/signout із токеном, який ви хочете деактивувати.
accept: application/json
X-Client-Name: <назва інтеграції (обов`язково)>
X-Client-Version: <версія інтеграції (обов`язково)>
Content-Type: application/json
{
"login": "<логін касира>",
"password": "<пароль касира>"
}
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/cashier/signin' \ -H 'accept: application/json' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version' \ -H 'Content-Type: application/json' \ -d '{ "login": "test_pqhb11111", "password": "test_pqhb11111"}'
{
"type": "bearer",
"token_type": "bearer",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiM2U3MDk4OTYtOGM4YS00ZTcwLThhNGYtZWRlZmYyZThlMjBkIiwic3ViIjoiNmZhOGEZNDgtMGZjOC00NTViLThjMjktODk1MzNiNTM5YzQxIiwibmJmIjoxNjUyNzI5ODkxLCJpYXQiOjE2NTI3Mjk4OTF9.ReYF8FicTFZiyi9s6NF6n3Y-VInbYa7_V1111111111"
}
Сам токен доступу - не має чіткого строку життя. Проте рекомендуємо його періодично змінювати для забезпечення безпеки передачі даних.
Також деактивація старого токену касира відбувається при використанні функції Заміни ключа касира, оскільки відбувається деактивація старого касира та реєстрація нового в Податковій Службі (хоча логін та пінкод касира в системі checkbox залишаються незмінними).
accept: application/json
X-Client-Name: <назва інтеграції (обов`язоково)>
X-Client-Version: <версія інтеграції (обов`язоково)>
Authorization: <токен авторизації>
Тіло запиту у даному випадку має бути порожнім.
curl -X 'POST' \ 'https://api.checkbox.ua/api/v1/cashier/signout' \ -H 'accept: application/json' \ -H 'X-Client-Name: Test-Client-Name' \ -H 'X-Client-Version: Test-Client-Version' \ -H 'Authorization: Bearer token' \ -d ''
null
null - у разі успішної деактивації токена авторизації