Реализация API в информационной системе партнера

M
Last updated 3 months ago

Веб-сервис CardsMobile Loyalty API развертывается в информационной системе партнера в соответствии с документацией CardsMobile Developer Zone. Для обмена сообщениями используется стандартная RESTful-модель, данные передаются в формате JSON:

Реализация API в информационной системе партнера

Поскольку веб-сервис API реализуется на хосте партнера, необходимо предоставить CardsMobile следующие данные для интеграции:

  • host:port

  • login:password

Авторизация запросов к API

Для авторизации API-запросов используется HTTP Basic Authentication.

Требования к кодировкам

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

Коды ответов API

Формат заголовка ответа со стороны партнера:

Content-Type: application/json; charset=utf-8;

HTTP-коды ответов со стороны партнера:

Код

Назначение

200

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

422

В случае ошибки выполнения запроса необходимо вернуть HTTP-код 422, код ошибки и строковое сообщение с техническим описанием причины ошибки на русском языке в кодировке UTF-8.

Пример ответа сервера в случае ошибки выполнения запроса:

HTTP: 422
{
"code": "123",
"description": "Недоступен сервер баз данных"
}