InSales API - Webhooks — различия между версиями

Материал из Insales Wiki
Перейти к: навигация, поиск
(Добавление)
(Добавление)
Строка 56: Строка 56:
 
     <address>http://application.ru/orders/update</address>
 
     <address>http://application.ru/orders/update</address>
 
     <topic>orders/update</topic>
 
     <topic>orders/update</topic>
 +
    <format>1</format>
 
</webhook>
 
</webhook>
 
</pre>
 
</pre>
 +
 +
Обратите внимание, что часть
 +
<pre>
 +
<format>1</format>
 +
</pre>
 +
 +
отвечает за формат данных отправляемых webhook'ом
 +
 +
0 - в XML формате
 +
 +
1 - в JSON формате
  
 
Ответ:
 
Ответ:
Строка 71: Строка 83:
 
</webhook>
 
</webhook>
 
</pre>
 
</pre>
 
Обратите внимание, что часть
 
<pre>
 
<format>1</format>
 
</pre>
 
 
отвечает за формат данных отправляемых webhook'ом
 
 
0 - в XML формате
 
 
1 - в JSON формате
 
  
 
=Удаление=
 
=Удаление=

Версия 12:24, 16 июня 2016

Доступные Webhooks

orders/create - вебхук на создание заказа

orders/update - вебхук на изменение заказа

orders/destroy - вебхук на удаление заказа

Получение списка

Запрос: GET /admin/webhooks.xml

Ответ:

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhooks type="array">
    <webhook>
        <id type="integer">830</id>
        <address>http://application.ru/orders/create</address>
        <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
        <topic>orders/create</topic>
    </webhook>
    <webhook>
        <id type="integer">831</id>
        <address>http://application.ru/orders/create</address>
        <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
        <topic>orders/update</topic>
    </webhook>
</webhooks>

Получение информации

Запрос: GET /admin/webhooks/#{id}.xml

Ответ:

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhook>
    <id type="integer">831</id>
    <address>http://application.ru/orders/create</address>
    <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
    <topic>orders/update</topic>
</webhook>

Добавление

Пока доступные значения для topic orders/create и orders/update

Запрос: POST /admin/webhooks.xml

<webhook>
    <address>http://application.ru/orders/update</address>
    <topic>orders/update</topic>
    <format>1</format>
</webhook>

Обратите внимание, что часть

 <format>1</format>

отвечает за формат данных отправляемых webhook'ом

0 - в XML формате

1 - в JSON формате

Ответ:

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhook>
    <id type="integer">831</id>
    <address>http://application.ru/orders/create</address>
    <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
    <topic>orders/update</topic>
    <format>1</format>
</webhook>

Удаление

Запрос: DELETE /admin/webhooks/#{id}.xml

Ответ:

HTTP/1.1 200 OK