2. API
3. Общее описание

Общее описание

Документация API находится по адресу https://api.labgame.ru/ 

 

API работает поверх HTTP протокола. В качестве формата для обмена данными используются JSON.

Параметры передаются в теле запроса в виде JSON документа, данные для авторизации - в заголовке (есть и другие варианты).

URL формируется следующим способом:

https://ваш-домен/api/v2/integration/модуль/метод

Структура ответа успешного вызова

{
  "result": <результат>
}

Структура ответа неудачного вызова

{
  "error": {
    "message": "<сообщение>",
    "code": <код>
  }
}

Постраничный вывод

Для получения большого объема данных используется постраничный вывод.

Для навигации используются параметры запроса page (страница) и limit (количество элементов на страницу).

Формат ответа такой:

{
  "result": {
    "meta": {
      "page": 1,
      "pages": 100,
      "limit": 10,
      "count": 1000
    },
    "data": [
        <элемент>, <элемент>, <элемент> ...
    ]
  }
}