Простыми словами, Webhook
— механизм получения
уведомлений об определённых событиях на свой собственный URL.
Для того, чтобы получать от нас автоматические уведомления о новых штрафах ваших транспортных средств (ваших клиентов), необходимо:
notificationType = "postback"
notificationUrl = "УРЛ_ПОЛУЧЕНИЯ_УВЕДОМЛЕНИЙ"
notificationFormat = "json"
Мы отправляем POST-запрос на указанный вами URL сразу же, как у нас появляется новая информация о штрафе (о каждом отдельно), будь то новый штраф у транспортного средства, либо обновился статус оплаты, или, например, появились новые изображения правонарушения.
Все запросы отправляются в кодировке UTF-8 и с заголовками:
Content-Type: application/json
{
"revision":1501716394.988136,
"type":"fine_change",
"data":{
"id":2953319,
"name":null,
"postNumber":"18810136170722049545",
"postedAt":"2017-07-22",
. . .
"docType":"sts",
"docNumber":"3620848239",
"createdAt":"2017-08-02 17:15:09",
"updatedAt":"2017-08-02 17:15:09",
"updatedMask":"1000"
}
}
{
"revision":1501716394.988136,
"type":"fine_change",
"user":{
"id":1234,
"email":"user@example.com",
"username":"Ivan Ivanovich"
},
"data":{
"id":2953319,
"name":null,
"postNumber":"18810136170722049545",
"postedAt":"2017-07-22",
. . .
"docType":"sts",
"docNumber":"3620848239",
"createdAt":"2017-08-02 17:15:09",
"updatedAt":"2017-08-02 17:15:09",
"updatedMask":"1000"
}
}
Информация о штрафе соотвествует предоставлению из документации:
После получения и обработки уведомления необходимо установить в ответе HTTP Status Code = 200 (успешное выполнение).
Если у вас много транспортных средств и штрафов, уведомлений может быть много, и чтобы их не пропустить, советуем организовать очередь для последующей обработки полученных данных.
Если у вас возникнут вопросы и/или предложения, пишите на development@shtrafovnet.ru.