Вебхук

Set Webhook

Даним методом встановлюється URL адреса куди при фіскалізації чеків, відкритті та закритті змін а також службових внесеннях та вилученнях буде надіслано POST запити з відповідною інформацією.

Налаштування зберігаються для кожної каси окремо.

Указана в даному запиті адреса повинна приймати POST запити із указаною в документації схемою та повертати статус-код 200, у разі якщо статус-код буде >= 400 або час очікування відповіді більше 10 секунд запит буде повторюватись протягом 4-х годин з експоненційним інтервалом (backoff-retry, збільшення від 1 секунди до 30 хвилин)

Під час встановлення налаштувань сервером CheckBox генерується секретний ключ та повертається у відповіді на даний метод, за допомогою цього ключа можна перевірити чи дійсно запит виконується серверами CheckBox.

Під час виконання виклику вебхуків тіло запиту хешується за допомогою алгоритму:

encodeBase64(
    HmacSHA256(
        secret_key,
        getBytesUTF-8(
            request_body
        )
    )
)
  • encodeBase64 - функція перетворення бінарних даних в Base64 формат wiki,
  • HmacSHA256 - функція створення хешу підпису даних wiki,
  • getBytesUTF-8 - функція перетворення рядка в бінарне представлення (в кодуванні UTF-8) wiki,
  • request_body - тіло запиту
  • secret_key - секретний ключ

з використання ключа та записується до заголовка x-request-signature, таким чином на стороні де отримується запит можна перевірити дійсність даних за тим же алгоритмом.

post/api/v1/webhook

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/webhook
  • Auth: HTTP bearer

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

string uuid required
OR
string required

Request body

urlstring uri required

Response

Successful Response

urlstring required
last_error_datestring date-time
last_error_messagestring
created_atstring date-time required
updated_atstring date-time
keystring required

Changes

No recorded changes to this operation across all 1 revision of this API.