App Inbox для мобильных приложений
App Inbox – еще один вариант коммуникации с вашими клиентами, предоставляемый eSputnik. Он позволяет отправлять уведомления в автоматическом и ручном режиме в их личный кабинет в мобильном приложении.
Общее описание App Inbox, его применение, преимущества в сравнении с другими каналами рассылки вы можете найти в статье “App Inbox: почему вы оцените этот канал и как его эффективно использовать”.
Настройка App Inbox для мобильных приложений
Настройка App Inbox включает в себя отправку запросов:
- Получение токена идентификации.
- Получение количества непрочитанных app-inbox-сообщений.
- Получение списка всех app-inbox-сообщений в мобильном приложении.
- Изменение статуса app-inbox-сообщений.
Получение токена аутентификации
Для получения токена аутентификации пользователя (authToken) отправляется запрос с вашего сервера к API eSputnik. Запрос должен быть аутентифицирован одним из способов, описанных в инструкции к API. Например, API-ключом.
В запросе необходимо передать известные поля пользователя: email, phone (хотя бы одно поле должно быть обязательным). Эти поля нужны для поиска контакта в eSputnik.
Метод запроса |
POST |
URL запроса |
https://esputnik.com/api/v1/auth/contact/token |
Заголовок запроса |
Content-Type: application/json |
Тело запроса |
|
Ответ |
|
В дальнейшем authToken используется для аутентификации всех app-inbox-запросов. Его нужно передавать в заголовке запроса ES-TOKEN. После каждого запроса текущий токен инвалидируется, а в заголовке ответа ES-TOKEN приходит новый, который используется для следующего запроса.
Если в ответ на любой app-inbox-запрос приходит статус 401, то запрос на получение токена необходимо повторить.
Получение количества непрочитанных app-inbox-сообщений
Запрос дает вам возможность получать информацию о количестве непрочитанных сообщений в мобильном приложении клиента. Запрос может выполняться регулярно.
Метод запроса |
GET |
URL запроса |
https://esputnik.com/appinbox/v1/messages/count |
Заголовок запроса |
ES-TOKEN: authToken |
Заголовок ответа |
ES-TOKEN: newAuthToken |
Ответ |
|
Если значение count > 0, пользователь должен увидеть индикатор непрочитанных сообщений.
Получение списка app-inbox-сообщений
Запрос позволяет получить в ответе список сообщений в мобильном приложении, включая следующие данные:
- id сообщения;
- дата создания;
- заголовок;
- текст сообщения;
- URL изображения;
- URL ссылки;
- статус сообщения (прочитанное или непрочитанное).
Метод запроса |
GET |
URL запроса |
https://esputnik.com/appinbox/v1/messages |
Заголовок запроса |
ES-TOKEN: authToken |
Заголовок ответа |
ES-TOKEN: newAuthToken |
Ответ |
|
Изменение статуса app-inbox-сообщений
Запрос используется для передачи события о прочтении сообщения. Необходимо передавать только идентификаторы сообщений, у которых newMessage=true.
Метод запроса |
POST |
URL запроса |
https://esputnik.com/appinbox/v1/messages/status |
Заголовок запроса |
ES-TOKEN: authToken |
Заголовок ответа |
ES-TOKEN: newAuthToken |
Тело запроса |
|
Ответ |
нет |
Создание App Inbox сообщений
Инструкция по созданию app-inbox-сообщений и их рассылке представлена на странице “Создание App-inbox-сообщений”.