Set Integration
Даним методом встановлюється URL адреса куди при редагуванні замовлення буде надіслано POST запити з відповідною інформацією.
Налаштування зберігаються для кожного касира окремо.
Указана в даному запиті адреса повинна приймати POST запити із указаною в документації схемою та повертати статус-код 200, у разі якщо статус-код буде >= 400 або час очікування відповіді більше 5 секунд у відповідь буде надіслана помилка.
Під час встановлення налаштувань сервером CheckBox генерується секретний ключ та повертається у відповіді на даний метод, за допомогою цього ключа можна перевірити чи дійсно запит виконується серверами CheckBox.
Під час виконання виклику вебхуків тіло запиту хешується за допомогою алгоритму:
encodeBase64(
HmacSHA256(
getBytesUTF-8(
request_body
)
secret_key
)
)
- encodeBase64 - функція перетворення бінарних даних в Base64 формат wiki,
- HmacSHA256 - функція створення хешу підпису даних wiki,
- getBytesUTF-8 - функція перетворення рядка в бінарне представлення (в кодуванні UTF-8) wiki,
- request_body - тіло запиту
з використання ключа та записується до заголовка x-request-signature, таким чином на стороні де отримується запит можна перевірити дійсність даних за тим же алгоритмом.
Request
- Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
- URL: https://api.checkbox.ua/api/v1/orders/integration
- Auth: HTTP bearer
Headers
Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'
Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.