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

Материал из Insales Wiki
Перейти к: навигация, поиск
(Добавление)
(Добавление)
 
(не показано 8 промежуточных версий 4 участников)
Строка 1: Строка 1:
 +
=Доступные Webhooks=
 +
 +
'''orders/create''' - вебхук на создание заказа
 +
 +
'''orders/update''' - вебхук на изменение заказа
 +
 +
'''orders/destroy''' - вебхук на удаление заказа
 +
 
=Получение списка=
 
=Получение списка=
  
Строка 43: Строка 51:
 
Пока доступные значения для topic orders/create и orders/update
 
Пока доступные значения для topic orders/create и orders/update
  
Запрос: POST /admin/webhooks/#{id}.xml
+
Запрос: POST /admin/webhooks.xml
 
<pre>
 
<pre>
 
<webhook>
 
<webhook>
 
     <address>http://application.ru/orders/update</address>
 
     <address>http://application.ru/orders/update</address>
 
     <topic>orders/update</topic>
 
     <topic>orders/update</topic>
 +
    <format-type>xml</format-type>
 
</webhook>
 
</webhook>
 
</pre>
 
</pre>
 +
 +
 +
Возможные значения format-type: xml, json .
  
 
Ответ:
 
Ответ:

Текущая версия на 08:38, 14 декабря 2017

Доступные 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-type>xml</format-type>
</webhook>


Возможные значения format-type: xml, 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>
</webhook>

Удаление

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

Ответ:

HTTP/1.1 200 OK