Вебхуки (Webhook)

Что такое вебхук (webhook)?

Под вебхуком подразумевается отправка запроса на установленный адрес по событию.

Отправка Вебхуков

В случае изменения статуса заказа отправляется вебхук на указанный адрес сервера.

Вебхуки отправляются (распространяются) на заказы, созданные с помощью API.

Настройка вебхуков

Настройка вебхуков

Настройка вебхуков производится в разделе Управление - Настройки. Подраздел Webhooks (Вебхуки).

Чтобы включить/отключить Вебхуки - использовать опцию "Вебхуки включены"

Поля Url и "Отправлять статусы" заполнять не обязательно.

Статус заказа

При создании заказа с помощью API, можно отправить переменные с адресом отправки хука (webhook_url - string), и списком статусов (webhook_statuses - string, перечислить коды API статусов через запятую), по которым требуется его отправить.

Если при создании заказа переменные статусов и адреса отправки не указаны, будут использованы те, что указаны в настройках.

Обработка Вебхука

Вебхук отправляет запрос с типом данных application/json.

Запрос содержит параметры:

event - собыите (order_status)

order_id - системный номер заказа на стороне Партнёр:Магазин

status_id - Код API установленного статуса (Код можно увидеть в разделе Справочники - Статусы)

status_name - Наименование установленного статуса

time - Дата и время смены статуса в формате "Y-m-d H:i:s"

Пример обработки вебхука используя язык PHP.

            /*    Обработка данных вебхука    */

            $input = file_get_contents('php://input');
            if($input) {
                $data = json_decode($input);
                $event = $data->event;
                $order_id = $data->order_id;
                $status_id = $data->status_id;
                $status_name = $data->status_name;
                $time = $data->time;
            }

Поделиться ссылкой на эту страницу: