Оглавление руководства

API позволяет связать хостинг с вашим интернет-магазином, CRM или внутренней системой: получать сведения об аккаунтах, создавать клиентов, работать с устройствами и автоматизировать отдельные операции. Для обычной работы через кабинет API не нужен.

Эта глава — отправная точка для интегратора, а не замена полного справочника. Операции, меняющие баланс, доступ или устройства, нужно разрабатывать и проверять отдельно от простого чтения.

Где взять ключ и справочник

Откройте Настройки → API ключ. Рядом находится ссылка на документацию. На учебном снимке ключ заменён на неработающее значение DEMO-KEY-NOT-VALID.

Доступен русский PDF-справочник API. Это справочник старого интерфейса: он полезен для перечня команд, но в примерах и пояснениях встречаются неточности. При расхождении ответа с примером передайте интегратору фактический ответ и уточните поведение у поддержки.

API-ключ и ссылка на справочник в настройках; показан неработающий учебный ключ

Ключ берётся из настроек владельца, а не из карточки клиента. DEMO-KEY-NOT-VALID нельзя использовать для запроса.

Адрес и авторизация

Запросы направляются на домен вашего клиентского сайта, например на /api/v1.1/account. Не подставляйте вместо него адрес кабинета hosting.livegpstracks.com: по домену определяется сайт хостинга.

Основные параметры:

Параметр Значение
xusername Логин владельца хостинга
xpassmd MD5 пароля основного аккаунта владельца
xkey Его API-ключ из настроек
username Логин клиента, с которым работает команда
action Действие выбранного метода

Пароли могут различаться. Изменение пароля в кабинете хостинга не обновляет пароль основного аккаунта. В старом API account проверяется именно основной аккаунт. Не используйте здесь пароль клиента.

MD5 не делает параметр безопасным для публикации: для этой авторизации он сам является секретом. Передавайте все параметры запроса вместе в POST по HTTPS с корректным сертификатом. Не размещайте их в URL, клиентском JavaScript, открытых логах и системах аналитики. Если HTTPS вашего домена ещё не настроен, сначала решите этот вопрос с поддержкой.

Начните с чтения аккаунта

Первый тест — action=get для уже существующего учебного клиента. Он не пополняет баланс, не создаёт устройство и не меняет тариф.

Структура запроса ниже иллюстративная. Домен и значения вымышленные; это не готовые рабочие реквизиты:

POST /api/v1.1/account HTTP/1.1
Host: monitoring.northline.example
Content-Type: application/x-www-form-urlencoded

action=get&username=riverfleet&xusername=northlineadmin&xpassmd=OWNER_PASSWORD_MD5&xkey=API_KEY

Тело запроса кодируется как обычная HTML-форма. Ответ — JSON. Проверяйте не только HTTP-статус, но и поле result: код успешного выполнения — 1000. Ответ может содержать отдельный элемент результата и отдельный массив данных; не считайте весь ответ одним объектом клиента.

После успеха сравните логин, баланс, валюту и назначенные данные с кабинетом. Только затем переходите к следующему методу.

Что можно автоматизировать

  • Работа с аккаунтами: чтение, создание, включение и отключение, изменение отдельных назначений и данных.
  • Работа с устройствами: получение списка, добавление и другие команды из справочника.
  • Получение координат через предусмотренные методы API.

Не все команды являются безопасным просмотром. Например, пополнение и активация устройства могут менять финансовые данные. После таймаута сначала проверьте результат операции; автоматический повтор без такой проверки может выполнить действие ещё раз. Начинайте интеграцию на отдельном тестовом клиенте и не запускайте массовые действия первым запросом.

Если API не отвечает как ожидается

  • HTML-страница или nginx 404 вместо JSON: проверьте домен и точный маршрут, затем обратитесь в поддержку. Это не подтверждение неверного пароля.
  • 1005 или 1006: проверьте владельца, домен сайта, комплект параметров, основной пароль и актуальность ключа.
  • 1001: проверьте обязательные поля выбранной команды.
  • 1012 при чтении аккаунта: проверьте логин клиента и его принадлежность вашему хостингу.

Для обращения сохраните время, адрес метода без секретных параметров, действие, HTTP-статус и очищенный JSON. После смены ключа обновите все интеграции.

Вернуться к оглавлению