АПИ
Версия № 1

Ваш IP-адрес: 52.204.98.217

Общая информация





Подключение

Для подключения к АПИ необходимо получить учетные даные доступа у администратора АПИ. Подключение к АПИ возможно только с одного, заранее согласованного IP-адреса.

Пример: https://strelatrans.com.ua/!api.php?version=1&user_id=XXXXX&key=YYYYY

XXXXX - идентификатор клиента (логин)
YYYYY - секретный ключ
version=1 - номер версии АПИ, на данный момент всегда 1

Формат данных ответа АПИ по умолчанию установлен в JSON. Если в целях отладки необходимо получать данные в текстовом виде, нужно дописать к запросу параметр fa=text.
Вся справочная информация (manual) выводится в текстовом формате, в не зависимости от значения fa.

Пример: https://strelatrans.com.ua/!api.php?version=1&fa=text&user_id=XXXXX&key=YYYYY
Если аутентификация пройдена успешно, отобразится сообщение об ошибке "не указан моудль", иначе будет выдана ошибка "error=ошибка аутентификации N"

Порядок указания параметров в запросе не имеет значения.

Зачастую основной запрос к АПИ будет выглядеть следующим образом:
http://[API_DOMAIN]/!api.php?version=[NUMBER_VERSION]&user_id=[CLIENT_ID]&key=[PASS]&fa=[OUTPUT_FORMAT]&module=[MODULE_NAME]&section1=[SECTION1_NAME]

[API_DOMAIN] ..... - доменное имя АПИ (https://strelatrans.com.ua).
[NUMBER_VERSION] . - всегда 1, в будущем планируется для указания номера версии АПИ.
[CLIENT_ID] ...... - идентификатор клиента.
[PASS] ........... - пароль.
[FORMAT_ANSWER] .. - если параметр не задан (&fa=text отсутствует в запросе), вывод результата в формате JSON, если указан text - вывод обычным текстом (полезно в ходе отладки, не следует использовать для автоматической обработки).
[MODULE_NAME] .... - выбор модуля для работы АПИ (например trackings)
[SECTION1_NAME] .. - раздел АПИ выбранного модуля.

Данные, полученные из АПИ необходимо хранить локально, во избежание превышения допустимого кол-ва запросов к АПИ. В случае, если будет достигнут лимит запросов к АПИ, клиент будет заблокирован на некоторое время, при повторных нарушениях - возможно полное отключение АПИ для клиента.

В ответе АПИ, если не произошло никаких ошибок, всегда возвращается имя запрошенного модуля [module], [ok] = 1 и переменная [api_date], в которой содержится время сервера АПИ в формате MySQL.
Также, если нет ошибок, HTTP статус ответа равен 200.
Всегда проверяйте HTTP-статус ответа, так как если сайт будет закрыт на тех. обслуживание, АПИ работать не будет, и HTTP-статус будет отличен от 200.





Модули

Модули - различные по функционалу разделы сайта. Просмотр списка доступных модулей доступен только после аутентификации.
Пример: https://strelatrans.com.ua/!api.php?version=1&user_id=XXXXX&key=YYYYY&info=modules