Изменения

Перейти к: навигация, поиск

Webhook

2909 байт добавлено, 22 октябрь
API Key
'''== Принцип работы ==Webhook передает данные по заказам и статусам на ваш URL.'''
Важно понимать, что на обработку очереди всех вебхуков, включая ваш, уходит время.
Чтобы создать оповещение о статусах на ваш URL, в разделе [[Личный_кабинет_клиента#Интеграция|"Интеграции"]] создайте интеграцию с типом "Webhook"За 1 раз наша система забирает максимум 100 ваших изменений. В настройках укажите URL По нашим средним подсчетам на который мы будем отправлять уведомлениеобработку и отправку этих данных может уйти 2 - 4 минуты.
Также нужно понимать, что вебхуки всех клиентов обрабатываются поочередно. То есть, сначала обрабатываются заказы по вебхуку первого клиента, потом заказы по вебхуку второго клиента, потом заказы по вебхуку третьего клиента и тд.
Таким образом, 100 ваших изменений вы будете получать не каждые 4 минуты, а только после того, как до вас снова дойдет ваша очередь. Это может происходить и каждые 4 минуты, если у других клиентов не было множества изменений по заказам.
 
== Настройка ==
В разделе [[Личный_кабинет_клиента#Интеграция|"Интеграции"]] создайте интеграцию с типом "Webhook". В настройках укажите URL на который мы будем отправлять вам данные.
 
== Авторизация ==
Интеграция поддерживает 3 типа авторизации
 
=== Basic Auth ===
Укажите '''Username''' и '''Password''' для Basic Auth авторизации
 
=== Bearer Token ===
Укажите '''Token ''' для Bearer Token авторизации
 
=== API Key ===
Данный тип авторизации позволяет передавать любой параметр в авторизации
 
'''Название key''' - название параметра
 
'''Значение key''' - значение параметра
 
'''Добавлять к''' - данная настройка позволяет указывать как передавать ваш параметр.
 
Можно передавать параметр в
 
'''Headers''' - в данном случае параметры добавляются в Headers
 
'''Query Params''' - в данном случае вместо XML шлется form-data с двумя параметрами: xml - XML тело и ваш параметр
 
== Формат данных в адрес получателя вебхука ==
Пример запроса:
<source lang=xml>
</source>
Подробное описание '''контейнера order''' вы можете увидеть на [[API#Примеры ответов 2|этой странице]]
== Формат ответа от получателя вебхука ==
<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
В случае успешной обработки вебхука, наша система ожидает от вас именно такой ответ:
</div>
Обязательный ответ(он сообщает, что вы получили наш вебхук. Как вы будете обрабатывать эти данные и будете ли обрабатывать их вообще не имеет значения дня нашей системы):
<source lang=json>
{
367
правок

Навигация