Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

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

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

...

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

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

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

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

Описание

X-Auth-Token

eyJhbGciOiJIUzUxMM....9rZ8VQ54JqWFe1Q

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

Api-Version

2

Версия API.

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

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

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

Code Block
languagejsrestructuredtext
POST /orders/{id}/ratings

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

Параметр

Тип

Описание

id

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

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

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

Code Block
languagejslinenumberstruejson
{"rating":4}

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

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

Коды ответа

HTTP-код

Описание

Код ошибки

200

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

400

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

bad_request

401

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

unauthorized

404

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

not_found