В тази секция ще намерите:
- Относно webhooks
- Добавяне на Webhook
- При получаване на Webhook, можете да очаквате статуси със следното съдържание
- Response Code
Относно webhooks
Webhook е метод за увеличаване или промяна на поведението на уеб страница или уеб приложение с персонализирани обратни обаждания. Тези обратни обаждания могат да бъдат поддържани, модифицирани и управлявани от потребители и разработчици от трети страни, които не е задължително да са свързани със създадения уебсайт или приложение. Терминът "webhook" е измислен от Джеф Линдзи през 2007 г.
Когато се случи събитието, към крайната точка се изпраща информация чрез API ключ. Данните за събития на Webhook могат да се съхраняват като JSON или XML.
Обичайните случаи на използване на webhook включват следното:
- Изпращане на известия до клиенти за бърз достъп
- Събиране на данни за съхранение на данни
- Интегриране със счетоводен софтуер
- Филтриране на артикули за поръчки и информиране на компании за поръчки
- Данните за клиенти се премахват от база данни
Добавяне на Webhook
1. Влезте във вашият контролен панел > Настройки > Webhooks > Добави webhook
2. API ключ - Оттук избирате API ключ. Можете да добавите "Default": Това е този който имате автоматично създаден на магазинът ви. Можете да създадете и нов ключ от менюто API ключове.
3. URL адрес на дестинацията - Това е URL адресът където webhook ще бъде изпратен
4. Изпълнение при - Тук избирате действие при което ще бъде изпълнен webhook.
5. Нова структура за Webhook - Възможност за използване на нова структура за Webhook при поръчка
Пример I: Ако има нова поръчка, действието ще изпълни webhook към дестинацията на зададения URL.
Пример II: Можете да видите примерен Webhook оттук: Order.json
При получаване на Webhook, можете да очаквате статуси със следното съдържание:
- Статус на поръчка:
pending, voided, timeouted, cancelled, failed, refunded, paid, complete - Статус на плащане:
requested, pending, held, completed, failed, refunded, cancelled, timeouted - Статус на изпращане:
not_fulfilled, fulfilled
Response Code
Има механизъм, който следи какъв е response code, който се връща от получателя. Ако response code е 200, всичко ще е наред. Ако response code е различен от 200 или се забавят повече от 5 секунди с отговора ще повтаряме до 5 пъти опитите да доставим информацията.
Отстояния между опитите:
1 - Изпраща се в реално време
2 - Изпраща се след 60 секунди от предходния
3 - Изпраща се след 120 секунди от предходния
4 - Изпраща се след 180 секунди от предходния
5 - Изпраща се след 240 секунди от предходния
6 - Изпраща се след 300 секунди от предходния
След 6 неуспешни опита, ако информацията не е получена, то тя няма да бъде изпратена повече. Ако получим response code 400, 401, 403, 404, 405, 406, 410, 411 ще деактивираме webhook-a в администрацията на магазина. Ако получим в отговора текст "please unsubscribe me" то този webhook ще бъде изтрит от администрацията на магазина