Оформление

Авторизация ​

Для работы с API необходимо передавать в HTTP запросе заголовок Authorization

bash
curl \
  -H "Authorization: 12345:AbCdR-_RtD" \
  https://toursystema.com/org-api/tour/list

Чтобы получить токен, необходимо обратиться в службу поддержки.

Аутентификция и авторизация ​

Все запросы к API должны быть авторизованными Вашим токеном, поэтому при отправке запроса с неверным токеном или без него вернется следующая ошибка:

Status Code: 401 Unauthorized

json
{
  "name": "Unauthorized",
  "code": 1,
  "detail": "Проверьте, что вы передаете токен доступа в заголовках запроса, а также, что токен верный.",
  "errors": []
}

Валидация ​

При отправке запросов к API происходит валидация входных данных на корректность.

Например, нельзя в параметр с типом данных integer передать строку, которая содержит не целое число.

Формат ошибки ​

Возвращается объект, ключами которого являются параметры, которые являются неверными, а значения - массивы строк, в которых перечислены ошибки валидации

Status Code: 422 Unprocessable Entity

json
{
  "name": "Data Validation Failed",
  "code": 2,
  "detail": "Проверьте соответствие типов данных переданных параметров",
  "errors": [
    {
      "field_name": "id",
      "message": "Значение должно быть целым числом."
    }
  ]
}

Status Code: 404 Not Found

json
{
  "name": "Not Found",
  "code": 3,
  "detail": "По переданным параметрам ничего не найдено",
  "errors": []
}