Webhook
Загальна інформація
Клієнт надає Webhook URL для автоматичного отримання залишків аптек на свій сервер.
Запити будуть надходити по всіх аптеках, з різними ID аптеки в кінці URL.
- Налаштування сервера
Налаштуйте ендпоінт для прийому запитів з інформацією про актуальні залишки аптеки. Ендпоінт має приймати дані у форматі JSON методом POST
- Реєстрація Webhook
Повідомте про бажання використовувати функцію Webhook та надайте ендпоінт вашого сервера для отримання даних.
Алгоритм роботи
- Вивантаження залишків
Клієнт вивантажує залишки з аптеки наступними методами:
- Отримання залишків
Система отримує залишки з аптеки.
- Надсилання POST-запиту на Webhook
Система автоматично надсилає POST-запит із JSON-даними на вказаний Webhook.
- Обробка даних
Ваш сервер отримує POST-запит, обробляє JSON-дані.
URI
URI: //yourserver.com/pharmapoint/stock/{id}
URL довільний і обовя'зково має прйимати ID аптеки
НАШ сервер робить відправку інформації на цей URL методом POST з тілом запиту у JSON форматі.
Авторизація буде виконана через заголовок API-Key
— унікальний API-ключ, що використо вується клієнтом для аутентифікації та авторизації.
Параметри Webhook
URL запиту має містити змінну:
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
id | string | Так | Ідентифікатор аптеки |
Параметри JSON
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
goods_id | string | Так | ID товару в аптеці |
ext_goods_id | string | Так | ID товару Фармапоінт |
quantity | float | Так | Кількість товару |
series | string | null | Ні | Серія товару |
expire_date | string | null | Ні | Термін придатності в форматі Y-m-d |
vat | integer | Так | Відсоток ПДВ |
online_price_vat | float | Так | Онлайн ціна з ПДВ |
drugstore_price_vat | float | Так | Ціна в аптеці з ПДВ |
Усі поля завжди присутні в запиті, але їх заповненість залежить від даних, отриманих від аптеки
Приклад JSON
[
{
"goods_id": "456790",
"ext_goods_id": "17",
"quantity": 1,
"series": "123123",
"expire_date": "2021-12-31",
"vat": 20,
"online_price_vat": 150,
"drugstore_price_vat": 160.8
},
{
"goods_id": "456790",
"ext_goods_id": "17",
"quantity": 1,
"series": "123123",
"expire_date": "2021-12-31",
"vat": 20,
"online_price_vat": 150,
"drugstore_price_vat": 160.8
}
]
Приклад успішної відповіді
Ми відправляємо інформацію на Ваш сервер, і сервер повинен надіслати код статусу відповіді - 200