Web API

Web API позволяет вам производить сложную интеграцию с Carrot quest и использовать систему на полную мощность.

Основы

Web API выдержан в стиле REST.
Все методы описаны в разделе методы.
Базовый URL: https://api.carrotquest.io.
Рекомендуется взаимодействовать с API через протокол HTTPS. Если такой возможности нет, можно использовать незащищенный протокол HTTP. Однако, в будущем мы оставляем за собой право ограничить использование API через HTTP.

Параметры запросов

Параметры могут передаваться как GET или POST параметры. Используется кодировка UTF-8.
Подробнее о типах параметров и способах их передачи.

Ответы запросов

Все ответы представляют собой JSON-объект. Используется стандартный "конверт":

{
  "meta": {
    "status": 200
  },
  "data": {
    ...
  }
}

Раздел meta содержит дополнительную информацию для разработчиков.

Поле status дублирует HTTP-код ответа. Статус 200 означает успешно выполненный запрос. Все остальные коды означают ошибку. Подробнее про стандартные ошибки.

Пример ответа с ошибкой:

{
  "meta": {
    "status": 400,
    "error_message": "The request could not be understood by the server due to malformed syntax",
    "error": "BadRequest"
  },
  "data": {}
}

Поле status содержит HTTP-код ошибки (400). Также появляются дополнительные поля error (название ошибки) и error_message (более подробное описание ошибки, понятное для человека).

Описание возможных ошибок можно найти на странице соответствующего метода или среди стандартных ошибок.