АПИ<br />
Версия № 1<br />
<br />
Ваш IP-адрес: 172.22.0.5<br />
<br />
Общая информация<br />
<br />
<br />
<br />
<br />
<br />
Подключение<br />
<br />
Для подключения к АПИ необходимо получить учетные даные доступа у администратора АПИ. Подключение к АПИ возможно только с одного, заранее согласованного IP-адреса.<br />
<br />
Пример: https://strelatrans.com.ua/!api.php?version=1&amp;user_id=XXXXX&amp;key=YYYYY<br />
<br />
XXXXX - идентификатор клиента (логин)<br />
YYYYY - секретный ключ<br />
version=1 - номер версии АПИ, на данный момент всегда 1<br />
<br />
Формат данных ответа АПИ по умолчанию установлен в JSON. Если в целях отладки необходимо получать данные в текстовом виде, нужно дописать к запросу параметр fa=text.<br />
Вся справочная информация (manual) выводится в текстовом формате, в не зависимости от значения fa.<br />
<br />
Пример: https://strelatrans.com.ua/!api.php?version=1&amp;fa=text&amp;user_id=XXXXX&amp;key=YYYYY<br />
Если аутентификация пройдена успешно, отобразится сообщение об ошибке "не указан моудль", иначе будет выдана ошибка "error=ошибка аутентификации N"<br />
<br />
Порядок указания параметров в запросе не имеет значения.<br />
<br />
Зачастую основной запрос к АПИ будет выглядеть следующим образом:<br />
http://[API_DOMAIN]/!api.php?version=[NUMBER_VERSION]&amp;user_id=[CLIENT_ID]&amp;key=[PASS]&amp;fa=[OUTPUT_FORMAT]&amp;module=[MODULE_NAME]&amp;section1=[SECTION1_NAME]<br />
<br />
[API_DOMAIN] ..... - доменное имя АПИ (https://strelatrans.com.ua).<br />
[NUMBER_VERSION] . - всегда 1, в будущем планируется для указания номера версии АПИ.<br />
[CLIENT_ID] ...... - идентификатор клиента.<br />
[PASS] ........... - пароль.<br />
[FORMAT_ANSWER] .. - если параметр не задан (&amp;fa=text отсутствует в запросе), вывод результата в формате JSON, если указан text - вывод обычным текстом (полезно в ходе отладки, не следует использовать для автоматической обработки).<br />
[MODULE_NAME] .... - выбор модуля для работы АПИ (например trackings)<br />
[SECTION1_NAME] .. - раздел АПИ выбранного модуля.<br />
<br />
Данные, полученные из АПИ необходимо хранить локально, во избежание превышения допустимого кол-ва запросов к АПИ. В случае, если будет достигнут лимит запросов к АПИ, клиент будет заблокирован на некоторое время, при повторных нарушениях - возможно полное отключение АПИ для клиента.<br />
<br />
В ответе АПИ, если не произошло никаких ошибок, всегда возвращается имя запрошенного модуля [module], [ok] = 1 и переменная [api_date], в которой содержится время сервера АПИ в формате MySQL.<br />
Также, если нет ошибок, HTTP статус ответа равен 200. <br />
Всегда проверяйте HTTP-статус ответа, так как если сайт будет закрыт на тех. обслуживание, АПИ работать не будет, и HTTP-статус будет отличен от 200. <br />
<br />
<br />
<br />
<br />
<br />
Модули<br />
<br />
Модули - различные по функционалу разделы сайта. Просмотр списка доступных модулей доступен только после аутентификации.<br />
Пример: https://strelatrans.com.ua/!api.php?version=1&amp;user_id=XXXXX&amp;key=YYYYY&amp;info=modules<br />
<br />
<br />
<br />
<br />
<br />
Просмотр списка ошибок авторизации<br />
https://strelatrans.com.ua/!api.php?error_directory_auth=yes<br />
<br />
Этот функционал служит для отображения всех возможных ошибок, чтобы в случае необходимости любую ошибку можно было перевести на необходимый язык.<br />
<br />
Если в ходе просмотра, добавления и других действий возникли ошибки, в ответе сервера АПИ добавляется две переменых: error_template_list, error_value_list.<br />
    error_template_list - шаблон(ы) сообщений об ошибках.<br />
    error_value_list - список значений, используемых в ошибках (если есть).<br />