Различия
Показаны различия между двумя версиями страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
start [22/03/2021 09:56] – zinenko | start [07/11/2023 09:40] (текущий) – karlov | ||
---|---|---|---|
Строка 1: | Строка 1: | ||
====== Хостинг Украина API ====== | ====== Хостинг Украина API ====== | ||
- | <callout type=" | + | <callout type=" |
- | === Внимание! | + | |
Документация находится в процессе доработки. Описания методов могут изменяться/ | Документация находится в процессе доработки. Описания методов могут изменяться/ | ||
</ | </ | ||
- | <callout type=" | + | Для API используется специальная прослойка между вызовами через веб-интерфейс панели управления. Она позволяет авторизоваться по токену, |
- | === Вопросы, | + | |
- | Любые вопросы, | + | |
- | </ | + | |
- | + | ||
- | Для API используется специальная прослойка между вызовами через веб-интерфейс панели управления. Она позволяет авторизоваться по токену, | + | |
< | < | ||
<col sm=" | <col sm=" | ||
- | <callout type=" | + | <callout type=" |
- | === Преимущества подхода: | + | |
* Большинство действий, | * Большинство действий, | ||
* Всегда актуальное API. Основной функционал панели управления сразу доступен через API. | * Всегда актуальное API. Основной функционал панели управления сразу доступен через API. | ||
Строка 26: | Строка 19: | ||
<col sm=" | <col sm=" | ||
- | <callout type=" | + | <callout type=" |
- | === Нюансы подхода: | + | |
* Некоторые функции API могут быть изменены без предупреждения. Однако по нашим наблюдениям появление новых параметров должно оказывать минимальное влияние на работу существующих функций API. | * Некоторые функции API могут быть изменены без предупреждения. Однако по нашим наблюдениям появление новых параметров должно оказывать минимальное влияние на работу существующих функций API. | ||
</ | </ | ||
Строка 33: | Строка 25: | ||
</ | </ | ||
</ | </ | ||
+ | |||
+ | ===== Методы ===== | ||
+ | |||
+ | * Учётная запись: | ||
+ | * [[service]] | ||
+ | * [[hosting]] | ||
+ | * [[extra]] | ||
+ | * Домены: | ||
+ | * [[domain|Регистрация и др.]] | ||
+ | * [[dns|Настройка и др.]] | ||
+ | * [[vps]] | ||
+ | * [[dedicated]] | ||
+ | * [[storage]] | ||
+ | * [[mysql]] | ||
+ | * [[mongo]] | ||
+ | * [[redis]] | ||
+ | * [[billing]] | ||
+ | * API: | ||
+ | * [[get_id]] | ||
+ | * [[params|Список параметров]] | ||
===== Использование ===== | ===== Использование ===== | ||
- | <callout type=" | + | Работа с API выполняется с помощью отправки запросов к нужным [[#Методы|методам]]. Необходимые для выполнения метода данные передаются с помощью GET или POST. В случае успеха метод выполняет нужное действие или возвращает какие-либо данные. |
- | === Важные моменты: === | + | |
- | * Ограничение доступа к API — 2 запроса в секунду для | + | Адрес для отправки запросов API:< |
- | | + | |
+ | ==== Авторизация ==== | ||
+ | |||
+ | Для авторизации используется [[https:// | ||
+ | |||
+ | ==== Отправка запросов ==== | ||
+ | |||
+ | <callout type=" | ||
+ | * Тестировать запросы к API можно в панели управления в [[https:// | ||
+ | * Простой класс для работы с API доступен на [[https:// | ||
+ | * В Python при использовании библиотеки requests необходимо добавлять заголовок '' | ||
+ | headers = { | ||
+ | ' | ||
+ | ' | ||
+ | }</ | ||
</ | </ | ||
- | Для | + | Пример |
+ | <?php | ||
+ | |||
+ | $ch = curl_init(" | ||
+ | curl_setopt_array($ch, | ||
+ | CURLOPT_POST => true, | ||
+ | CURLOPT_RETURNTRANSFER => true, | ||
+ | CURLOPT_HTTPHEADER => array(" | ||
+ | CURLOPT_POSTFIELDS => http_build_query([" | ||
+ | CURLOPT_VERBOSE => true, | ||
+ | )); | ||
+ | |||
+ | $response = curl_exec($ch); | ||
+ | </ | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | ==== Коды ответов ==== | ||
+ | |||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
- | Адрес для отправки запросов API:< | + | ==== Общая |
- | Пример использования:<code php><? | + | <code json> |
- | | + | { |
- | curl_setopt_array($ch, array( | + | " |
- | | + | "response" |
- | CURLOPT_RETURNTRANSFER => true, | + | "messages": { // Список сообщений |
- | CURLOPT_HTTPHEADER => array("Authorization: | + | "success": [ |
- | | + | |
- | | + | ], |
- | | + | |
- | | + | |
+ | | ||
+ | | ||
+ | } | ||
</ | </ | ||
- | * '' | + | ==== Лимиты |
- | * '' | + | |
- | Простой тестовый класс для работы с API доступен на [[https:// | + | Количество запросов к API: |
+ | * В час — не | ||
+ | * В день — не более 5000. | ||
- | ===== Коды ответов | + | В ответе на каждый запрос к любому методу |
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
- | * **200 OK** — событие отработало успешно без ошибок или исключений. | + | Повторные |
- | * **400 Bad Request** — в процессе работы события возникла ошибка | + | |
- | * **401 Unauthorized** — некорректный | + | |
- | * **403 Forbidden** — ошибка доступа к событию. | + | |
- | * **405 Method Not Allowed** — попытка обращения к несуществующему событию. | + | |
- | * **429 Too Many Requests** — слишком много | + | |
- | ===== События ===== | + | ===== Недоступно через API ===== |
- | {{indexmenu> | + | Некоторые операции можно выполнять только вручную через панель управления или Telegram-бота, |