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

Внимание!

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

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

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

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

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

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

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

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

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

Количество запросов к API ограничено 300 запросами в час и 5000 — в день. В HTTP заголовках ответа, для любого метода, также будут возвращены актуальные ограничения запросов:
- X-RateLimit-Hour — возможное количество запросов в час.
- X-RateLimit-Hour-Remaining — оставшееся количество запросов в час.
- X-RateLimit-Day — возможное количество запросов в сутки.
- X-RateLimit-Day-Remaining — оставшееся количество запросов в сутки.
Для авторизации используется Bearer token.
При использовании библиотеки requests в python необходимо добавлять заголовок для определения User-Agent на любой другой, например:
```
headers = {
    'Authorization': 'Bearer <ваш_токен>',
    'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'
}
```

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

Тестирование запросов 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);