Как пользоваться документацией¶
Документация организована по разделам, каждый из которых посвящён определённой части платформы ГдеМои:
- Общая информация: Введение и описание структуры документации, а также описание инструмента для тестирования API вызовов.
- API пользовательского интерфейса: API вызовы для функционала пользовательского интерфейса — данные устройств, трекинг, отчёты, задания и многое другое.
- API панели администратора: API вызовы для панели администратора — настройки платформы, управление пользователями и пр.
Навигация¶
Навигация между разделами осуществляется через верхнее меню. В левой части экрана отображается список файлов каждого раздела — нажмите, чтобы просмотреть содержимое. Внутреннее меню документа справа позволяет быстро перемещаться по разделам внутри этого документа.
Структура документации¶
Документация включает три типа файлов: Общая информация, Руководства и API-вызовы. Документы и руководства разделены на логические части, начиная с введения, в котором кратко изложено содержание.
Описание API-вызовов¶
- Введение — Общая информация и назначение документа.
- Структура объекта — Описание структуры объекта, используемой в вызовах (опционально).
- API запросы — Запрос API и связанные с ним действия, включая:
- Описание запроса — Описание API запроса.
- Требования — Необходимые разрешения для выполнения запроса с используемым ключом сессии (опционально).
- Таблица параметров — Список параметров API запроса с описаниями и типами данных.
- Примеры — Примеры API запросов с параметрами. Для удобства добавлена кнопка копирования.
- Ответ — Пример успешного ответа сервера с описанием полей.
- Ошибки — Специфические ошибки, связанные с API запросом, либо ссылка на общий список ошибок.
Ограничения API¶
Для обеспечения стабильной работы системы для всех клиентов, платформой ограничено количество запросов к API до 50 в секунду на каждого пользователя и каждый IP-адрес (для приложений, обслуживающих нескольких пользователей). Эти ограничения применяются на основе хэша сессии и API ключей.