1.11. Работа с API

  1. Откройте раздел «API»:
  2. На вкладке «Данные доступа» установите галочку напротив «Я соглашаюсь с пользовательским соглашением и правилами предоставления услуг» и нажмите «Активировать токен»:

Внимание!

Настоятельно рекомендуется настроить ограничение доступа к API по IP.

Ограничения доступа настраиваются на вкладке «Ограничение доступа»:

Логика работы следующая:

  • Список адресов пуст — доступ открыт для всех.
  • В списке есть один или несколько адресов — доступ открыт только для адресов из списка, для остальных закрыт.

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

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

В блоке «Методы» отображается список доступных методов:

Внимание!

Документация находится в стадии доработки, поэтому подробные описания есть не у всех методов.

Блок с названием выбранного метода содержит его подробное описание:

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

В левой части блока «Выполнение запроса» расположена форма для быстрой отправки запроса от имени текущей учётной записи, в правой выводится код ответа и результат отправленного запроса:

В блоке «Пример кода» выводится пример кода для использования текущего метода с помощью cURL или библиотеки HostingAPI:

  • Текущий активный токен автоматически подставляется в строку с параметром $auth_token. Если токен не активен, его нужно будет активировать и подставлять в код вручную.
  • Параметры из формы после выполнения запроса автоматически подставляются в строку с параметром $post. Если запрос не выполнялся, параметры нужно будет указывать самостоятельно.
Содержание