Настройка функции Webhook
Система обновлений в режиме реального времени
API сервиса «Моя посылка» поддерживает функцию webhook, которая позволяет сторонним приложениям подписаться на уведомления об изменении определенных данных и получать их в режиме реального времени.
На данный момент функция webhook оповещает о следующих событиях:
- наступление новых статусов при отслеживании трек-номера;
- добавление трек-номера на отслеживание;
- удаление трек-номера с отслеживания;
- пометка о доставке трек-номера;
- снятие пометки о доставке трек-номера.
В каждом из представленных событий сервис «Моя посылка» формирует специальный объект данных в формате json и отправляет методом POST в теле запроса на заранее сохраненный URL-адрес обратного вызова вашего приложения.
Структура объектов данных
В случае изменения определенных данных сервис «Моя посылка» формирует json структуру по каждому типу события следующего вида:
Новые статусы отслеживаемого трек-номера
{
"newEvents": [Tracker]
}Добавление трек-номера на отслеживание
{
"addTracker": [Tracker]
}Удаление трек-номера с отслеживания
{
"deleteTracker": {
"barcode": "...",
"carrier": "..."
}
}Пометка о доставке трек-номера
{
"trackerDelivered": {
"barcode": "...",
"carrier": "..."
}
}Снятие пометки о доставке трек-номера
{
"trackerUndelivered": {
"barcode": "...",
"carrier": "..."
}
}где:
- [Tracker] - структура объекта используемой приложением версии API;
- barcode - трек-номер отслеживания;
- carrier - код почтовой службы.