Как подключиться к API

В этой статье мы разберём, как авторизоваться и выполнить запрос к API. После этого вы сможете отправлять команды на сервер и получать от него данные.

Адрес API

Все запросы отправляются по адресу:

https://<server_address>/api/api.php

<server_address> — это адрес сервера или хоста, где работает PILOT.

Например:

Для пользователей: https://pilot-gps.com/api/api.php
Для администраторов: https://admin.pilot-gps.com/ax/api.php

API может находиться в разных «папках» проекта, и это отражается в адресе запроса, например:

https://<server_address>/backend/api.php

https://<server_address>/ax/api.php

Папки (api, backend, ax и другие) — это просто структура проекта. Они показывают, к какому набору команд вы обращаетесь. Всегда используйте полный путь к папке, который указан в конкретной команде API, иначе запрос не сработает.

Тип авторизации

Для подключения к API используется Basic Auth.

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

Для работы с API администратора используйте логин и пароль администратора.

Как выглядит запрос

Общая форма запроса такая:

https://<server_address>/api/api.php?cmd=<command>&node=<node_num>

cmd — команда, которую вы хотите выполнить
node — номер узла, на котором нужно выполнить команду

Пример ответа

На ваш запрос сервер вернёт ответ в формате JSON:

{

"code": 0,

"msg": "OK",

...запрошенные данные...

}

code = 0 — всё прошло успешно
code = 1 — произошла ошибка
msg — сообщение от сервера (например, "OK" или описание ошибки)

Если вам удобнее работать с XML, добавьте к запросу параметр out=xml — и результат придёт в формате XML.

Пример запроса:

https://<address>/api/api.php?cmd=<command>&node=<node_num>&out=xml

Ответ в этом случае будет таким:

...запрошенные данные...

</response>

Если вы только начинаете знакомство с API, рекомендуем сначала прочитать статью Работа с API-запросами, чтобы понять, что такое команды, параметры и форматы данных.