start

Хостинг Украина API

Внимание!

Документация находится в процессе доработки. Описания методов могут изменяться/дополняться.

Вопросы, пожелания и предложения

Любые вопросы, связанные с API, а также пожелания и предложения по улучшению его работы оставляйте в специальном разделе на нашем форуме.

Для API используется специальная прослойка между вызовами через веб-интерфейс панели управления. Она позволяет авторизоваться по токену, выполнять запросы от имени пользователя и получать ответы в формате JSON

Преимущества подхода:

  • Большинство действий, которые можно выполнять через панель управления, могут быть выполнены через API.
  • Всегда актуальное API. Основной функционал панели управления сразу доступен через API.
  • Стабильность работы API. Работа панели управления ежедневно проверяется тысячами пользователей.

Нюансы подхода:

  • Некоторые функции API могут быть изменены без предупреждения. Однако по нашим наблюдениям появление новых параметров должно оказывать минимальное влияние на работу существующих функций API.

Важные моменты:

  • Ограничение доступа к API — 2 запроса в секунду для токена.
  • Для авторизации используется Bearer token.

Тестирование

Тестирование запросов API можно производить непосредственно в API-песочнице панели управления.

Для использования API нужно отправлять запросы к определённым событиям, передавая необходимые данные методами GET или POST. Запрос будет выполнен только в том случае, если присутствует авторизационный заголовок Authorization: Bearer [token].

Адрес для отправки запросов API:

https://adm.tools/actions/событие

Пример использования:

<?php
    $ch = curl_init("https://adm.tools/action/path/to/method/?gdata1=value3&gdata2=value4");
    curl_setopt_array($ch, array(
        CURLOPT_POST => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => array("Authorization: Bearer placeuserapitokenhere"),
        CURLOPT_POSTFIELDS => http_build_query(["data1" => "value1", "data2" => "value2", "data3" => ["1" => "subvalue1", "2" => "subvalue2"]]),
        CURLOPT_VERBOSE => true,
    ));
    $response = curl_exec($ch);
  • gdata* — GET параметры для передачи данных, если в методе они используются.
  • data* — POST параметры для передачи данных, если в методе они используются.

Простой тестовый класс для работы с API доступен на GitHub.

  • 200 OK — событие отработало успешно без ошибок или исключений.
  • 400 Bad Request — в процессе работы события возникла ошибка или исключение.
  • 401 Unauthorized — некорректный токен.
  • 403 Forbidden — ошибка доступа к событию.
  • 405 Method Not Allowed — попытка обращения к несуществующему событию.
  • 429 Too Many Requests — слишком много запросов (более 2 в секунду).
  • start.txt
  • Последнее изменение: 5 мес. назад
  • zinenko