Інтеграція клієнтів BitFaktura за допомогою webhook

Created: 19.05.2021
Last updated: 09.07.2021
Кількість відвідувань статті: 68

Веб-хуки - поряд із інтерфейсом програмування API - механізм, що дозволяє спілкуватися між серверами. Він призначений в основному для розробників та досвідчених користувачів.

Використання веб-хуків зменшує навантаження на сервер додатків, оскільки необхідна інформація автоматично надсилається, коли відбувається певна подія, тому немає необхідності запитувати інтерфейс API, чи були внесені зміни. Сповіщення про події надходять саме тоді, коли вони відбуваються, без необхідності занадто часто висилати запити до програми.

Webhook має:

тип, який визначає час надсилання веб-хука (після створення / оновлення / видалення клієнта)

URL - це URL-адреса, куди надсилається веб-хук

Маркер API, тобто маркер автентифікації, який користувач може додати до веб-хука і який знаходиться під ключем 'api_token'

Веб-хук - це POST, що надсилається на вказану URL-адресу з такою структурою:

{
client_id: <унікальний ідентифікатор, що представляє клієнта в базі даних BitFaktura>,
клієнт: {<словник, що представляє клієнта у BitFaktura>},
app_name: 'виставлення рахунка',
api_token: <api_token, введений користувачем у веб-хуку>,
мова: I18n.locale (наприклад, "ua")
}



Назад


Додати коментар