Синхронное HTTP API

Типичный пример использования http api: GET-запрос с параметрами или POST-запросы, где теле — JSON. Если всё хорошо, код ответа 200 и контент:

{"ok": true, "result": ...}

Если есть ошибки в данных, код отличается от 200, и контент:

{"ok": false, "error": КОД_ОШИБКИ, ...дополнительные поля...}

Подробное описание ошибок HTTP API.

Для большинства запросов требуется токен. Токен передаётся в заголовке Token. Например, так:

curl \
    --header "Token: joweipeijorw0rflhf4rwfasdf8134gr234rwf" \
    https://web.tada.team/api/v3/me/

Отладка

JSON по умолчанию компактен, без пробелов и отступов. Но если к пути добавить ?debug=true, появятся отступы.

Язык интерфейса

Поддерживается два языка: ru и en.

Настройка пользователя default_lang используется только как хранилище для клиентов.

API и ws отдаёт язык основываясь только на (в порядке приоритета):

  • ?lang=en
  • --header "Lang: en"
  • настройку сервера (по умолчанию ru)

Для пушей используется язык, который хранится в устройстве для пушей. Обновление языка в устройстве происходит при авторизации.