Push Callback API v1.0.0

API для информирования о доставке пуш-сообщений пользователям Кошелька.

Общие сведения

Руководство предназначено для компаний-партнёров ООО «Бесконтакт», желающих организовать выпуск карт лояльности своих клиентов в мобильном приложении «Кошелёк», используя платформу «Кошелёк».

Push Callback API предоставляет интерфейс для получения информации о доставке пуш-сообщений на устройства клиентов.

Модель взаимодействия

API использует модель RESTful (данные передаются в виде объектов JSON). Особенностью является использование партнёром и Кошельком двух интерфейсов:

Push API — используется партнёром для отправки пуш-сообщений;
Callback API — используется Кошельком для передачи информации о доставке и прочтении сообщений.

Взаимодействие партнёра и Кошелька

Подключение

Провайдером Push Callback API выступает узел партнёра.

Партнёру необходимо предоставить «обратный» URL-адрес, который будет использоваться хостом Кошелька для информирования о доставке и прочтении отправляемых сообщений.

Авторизация

Взаимодействие осуществляется по протоколу HTTPS. Для авторизации запросов необходимо использовать HTTP Basic Authentication (RFC 7617). Данные для авторизации запросов передаются в заголовке Authorization.

Кодировки

Как в запросах, так и в ответах API используется кодировка UTF-8.

Коды HTTP

В случае успешного выполнения запроса, со стороны узла партнёра должен быть возвращён тип данных, описанный в документации запроса, и HTTP-код 200.