API оценки клиентов

Использование API

Rating API - программный интерфейс для оценки сервиса предоставленного пользователю. Позволяет дать оценку по шкале от 1 до 5 после успешной оплаты по QR-коду.

Транспорт и протокол

В качестве транспорта используется HTTPS протокол. Сообщения представлены в JSON формате.

Общие положения

Мобильное приложение взаимодействует с сервером по протоколу REST. Протокол REST односторонний, только клиент может сделать запрос к серверу и получить ответ. Сервер не может передать данные на клиента без запроса. 

Для выполнения большинства запросов необходима аутентификация. Запрос должен содержать заголовок X-Auth-Token, значением которого является JWT-токен. 

Список заголовков, которые необходимо обязательно передавать в API запросах:

Название поля

Пример значения

Описание

Название поля

Пример значения

Описание

X-Auth-Token

eyJhbGciOiJIUzUxMM....9rZ8VQ54JqWFe1Q

Токен приходит после регистрации или после входа в приложение.

Api-Version

2

Версия API.

Оценка сервиса

Оценить сервис возможно после успешной оплаты по QR-коду

Формат запроса

1 POST /orders/{id}/ratings

Для оценки сервиса необходимо отправить запрос с передачей следующих параметров:

Параметр

Тип

Описание

Параметр

Тип

Описание

id

string, обязательный

Уникальный идентификатор заказа в системе SWiP.

Пример тела ответа

1 {"rating":4}

Поле rating может принимать значения от 1 до 5.

В качестве ответа используется HTTP-код.

Коды ответа

HTTP-код

Описание

Код ошибки

HTTP-код

Описание

Код ошибки

200

Успешный запрос.

 

400

Неправильный запрос из-за нарушения правил взаимодействия с API.

bad_request

401

Неудачная авторизация.

unauthorized

404

Заказ по указанному id не был найден в SWiP.

not_found