InSales API - Уведомления пользователя

Материал из Insales Wiki
Перейти к: навигация, поиск

Что этот такое?

Уведомления это короткие сообщения которые показываются пользователю в шапке бекофиса. Сообщение может содержать html, например ссылку на более развернутое сообщение. Выглядит это так:

Notification.png

Это удобно для уведомления пользователей об особо важных событиях таких как: технические работы, критичные ситуации, глобальные изменения в приложении.

По умолчанию API уведомлений отключено и на все запросы к нему отдается ответ с кодом 403. Его включение нужно согласовывать с отделом по работе с партнерами [1].

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

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

Ответ:

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<notifications type="array">
    <notification>
        <id type="integer">830</id>
        <message>Приложение "..." завтра с 2 до 3 ночи по Москве не будет доступно из-за провдения технических работ.</message>
        <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
    </notification>
    <notification>
        <id type="integer">831</id>
        <message>У нас для вас хорошая новость: ...</message>
        <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
    </notification>
</notifications>

Добавление

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

<notification>
    <message>Приложение "..." завтра с 2 до 3 ночи по Москве не будет доступно из-за провдения технических работ.</message>
</notification>

Ответ:

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<notification>
     <id type="integer">831</id>
     <message>Приложение "..." завтра с 2 до 3 ночи по Москве не будет доступно из-за провдения технических работ.</message>
     <created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
</notification>

Удаление

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

Ответ:

HTTP/1.1 200 OK