start

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

Внимание!

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

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

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

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

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

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

Работа с API выполняется с помощью отправки запросов к нужным методам. Необходимые для выполнения метода данные передаются с помощью GET или POST. В случае успеха метод выполняет нужное действие или возвращает какие-либо данные.

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

https://adm.tools/actions/метод

Для авторизации используется Bearer token. Система выполняет только те запросы, в которых присутствует заголовок Authorization: Bearer токен, где токен — это ваш токен API.

Примечания:

  • Тестировать запросы к API можно в панели управления в API-песочнице.
  • Простой класс для работы с API доступен на GitHub.
  • В Python при использовании библиотеки requests необходимо добавлять заголовок User-Agent, например:
    headers = {
        'Authorization': 'Bearer токен',
        'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'
    }

Пример простого скрипта:

<?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 токен"),
    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-параметры с нужными данными (если используются в методе).
  • 200 OK — метод отработал успешно без ошибок или исключений.
  • 400 Bad Request — в процессе работы метода возникла ошибка или исключение.
  • 401 Unauthorized — некорректный токен.
  • 403 Forbidden — ошибка доступа к методу.
  • 405 Method Not Allowed — попытка обращения к несуществующему методу.
  • 429 Too Many Requests — слишком много запросов (см. лимиты).

Количество запросов к API:

  • В час — не более 300.
  • В день — не более 5000.

В ответе на каждый запрос к любому методу возвращаются HTTP-заголовки с информацией о лимитах:

  • X-RateLimit-Hour — возможное количество запросов в час.
  • X-RateLimit-Hour-Remaining — оставшееся количество запросов в час.
  • X-RateLimit-Day — возможное количество запросов в сутки.
  • X-RateLimit-Day-Remaining — оставшееся количество запросов в сутки.
  • start.txt
  • Последнее изменение: 3 нед. назад
  • karlov