1.11. Робота з API

Примітки:

  • Токен прив’язаний до облікового запису та дозволяє керувати всіма послугами, які в ньому доступні, у тому числі делегованими.
  • Токен діє 6 місяців із моменту останнього використання.
  1. Відкрийте розділ «API».
  2. На вкладці «Дані доступу» відзначте «Я погоджуюся з угодою користувача та правилами надання послуг» і натисніть «Активувати токен»:

Ліміти на кількість запитів до API:

  • За годину — не більше 300 запитів.
  • За добу — не більше 5000 запитів.
Інформація про час останнього запиту та поточну кількість надісланих запитів відображається в розділі «API».

У відповідь на кожен запит додаються заголовки HTTP:

  • З поточними лімітами:
    • X-RateLimit-Hour: 300 — на годину.
    • X-RateLimit-Day: 5000 — на добу.
  • Кількість запитів, що залишилася до вичерпання лімітів:
    • X-RateLimit-Hour-Remaining: XXX — на годину.
    • X-RateLimit-Day-Remaining: XXXX — на добу.

Кількість запитів за секунду/хвилину не обмежується.

При перевищенні ліміту у відповідь на запит буде повертатися повідомлення про помилку зі значенням ліміту і кількістю секунд до його скидання:

  • «Too Many Requests per hour. Limit 300. Pause XXX seconds» — для годинного ліміту.
  • «Too Many Requests per day. Limit 5000. Pause XXXX seconds» — для добового ліміту.

Також при досягненні лімітів надсилається відповідне повідомлення на пошту і в Telegram (але не частіше одного разу на тиждень).

Увага!

Рекомендовано налаштувати обмеження доступу до API по IP.

Обмеження доступу налаштовуються на вкладці «Обмеження доступу»:

Логіка роботи наступна:

  • Список адрес порожній — доступ відкритий для всіх.
  • У списку є один або кілька адрес — доступ відкритий тільки для адрес зі списку, для інших закритий.

Адреси та підмережі в форматі CIDR додаються в список дозволених кнопкою «Додати IP у список дозволених». Всі додані адреси відображаються в списку нижче. До кожної з них можна додати примітку або видалити зі списку.

Ознайомитися зі списком методів, їх описами, протестувати їх роботу і отримати приклади коду можна на вкладці «Документація». Вкладка складається з декількох блоків.

У блоці «Методи» відображається список доступних методів:

Увага!

Документація знаходиться в стадії доопрацювання, тому докладні описи є не у всіх методів.

Блок з назвою обраного методу містить його докладний опис:

  • Метод відправки запиту — GET або POST.
  • URL — адреса, за якою має надсилатися запит.
  • Параметри — список доступних параметрів, типи даних для кожного з них і варіанти доступних значень.
  • Детальний опис методу і значень, які він повертає (не для всіх методів).

У лівій частині блоку «Виконання запиту» розташована форма для швидкого відправлення запиту від імені поточної облікового запису, в правій виводиться код відповіді і результат відправленого запиту:

У блоці «Приклад коду» виводиться приклад коду для використання поточного методу за допомогою cURL або бібліотеки HostingAPI:

  • Поточний активний токен автоматично підставляється в рядок з параметром $auth_token. Якщо токен не активний, його потрібно буде активувати і підставляті в код вручну.
  • Параметри з форми після виконання запиту автоматично підставляються в рядок з параметром $post. Якщо запит не виконувався, параметри потрібно буде вказувати самостійно.
Зміст