Справочник HTTP API¶
HTTP API позволяет интегрировать возможности удалённого доступа и управления устройствами в ваши собственные сервисы, приложения или внутренние системы. С его помощью можно автоматизировать работу с устройствами, подключениями, пользователями и другими сущностями платформы без необходимости выполнять действия вручную через панель управления. API подходит для партнёров, разработчиков и компаний, которым требуется встроить функциональность удалённого доступа в свои бизнес-процессы или продукты.
Пример интеграции
Ознакомьтесь с примерами интеграции в руководствах для технических специалистов в разделе HTTP API.
Запросы¶
Все запросы должны выполняться по протоколу HTTPS (не HTTP) с использованием соответствующего метода для каждой команды по URL:
Аутентификация¶
API является RESTful: сервер не хранит состояние подключения клиента. Поэтому клиент должен отправлять данные авторизации при каждом запросе. В качестве таких данных используется ключ API. Добавляйте ключ в каждом запросе в HTTP-заголовке X-Api-Key:
Где получить API-ключ?
Ваш API-ключ можно найти в личном профиле в разделе Интеграция на вкладке HTTP API .
Ответы¶
Ответы с данными возвращаются в формате JSON UTF-8 с заголовком ContentType: application/json. Каждый ответ содержит данные внутри data контейнера JSON.
Сервер API может возвращать следующие коды HTTP-ответов:
| Код HTTP-ответа | Описание |
|---|---|
200 OK | Запрос принят и обработан |
400 Bad Request | Запрос отклонён: неверные параметры или ошибка |
402 Payment Required | Запрос отклонён: превышен лимит запросов для тарифного плана |
403 Forbidden | Запрос отклонён: нет доступа к данным |
404 Not Found | Запрос отклонён: неизвестный URL запроса |
Доступные методы¶
Подробные описания доступных методов приведены на отдельных страницах. Для удобства мы сгруппировали методы по функциям системы, чтобы они соответствовали структуре интерфейса панели управления: