Документация API

Сводка

- Все запросы к API должны включать в себя ключ, полученный из метода /api/auth*.
- Ключ передается в заголовках, вида Bearer: {key}.
- Ограничение на число запросов в секунду составляет - 3шт**. В случае превышения, в ответ будет возвращен HTTP код: 429.
- В рамках "тестирования" апи, учетной записи выдается отдельный ключ, который позволит совершить нелимитированное количество запросов, получая в ответ подготовленные шаблоны, для примера.
- Суммарное количество запросов, которые можно отправить с валидным ключом, регламентируется выбранным тарифом в ЛК.

* - Метод /api/auth единственный, который не требует ключ, вместо него отправляются доступы, полученные в ЛК.
** - В случае регулярного превышения запросов, ключ будет аннулирован, а учетная запись получит ограничение на получение нового ключа, сроком от 4 часов.

Оглавление

Список методов, количество и обязательность параметров может измениться в будущем.

/api/auth — Аутентификация учетных данных и возврат токена для запросов /api/domain — Проверьте возможность регистрации домена во всех доступных зонах /api/generator — Сгенерировать домен по ключу(чам) /api/location — Получить информацию о местоположении домена или IP /api/whois — Получить WHOIS данные домена или IP /api/lookup — Поиск информации о домене или IP /api/dns — Получить информацию о DNS домена или IP /api/tags — Получить мета-теги домена /api/cert — Получить информацию о сертификате домена /api/drop — Получить информацию о дропах доменной зоны /api/bill — Сведения о балансе, средств, кол-ве оставшихся запросов, дате следующего списания и т.д.

/api/auth

Аутентификация учетных данных и возврат токена для запросов

Параметры:

  • credentails
  • - Тип: mixed
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/domain

Проверьте возможность регистрации домена во всех доступных зонах

Параметры:

  • domain
  • - Тип: mixed
  • - Обязательный: Да
  • - По умолчанию: Нет
  • options
  • - Тип: mixed
  • - Обязательный: Да
  • - По умолчанию: Нет

/api/generator

Сгенерировать домен по ключу(чам)

Параметры:

  • keys
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/location

Получить информацию о местоположении домена или IP

Параметры:

  • url
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/whois

Получить WHOIS данные домена или IP

Параметры:

  • url
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/lookup

Поиск информации о домене или IP

Параметры:

  • url
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/dns

Получить информацию о DNS домена или IP

Параметры:

  • url
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/tags

Получить мета-теги домена

Параметры:

  • domain
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/cert

Получить информацию о сертификате домена

Параметры:

  • domain
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/drop

Получить информацию о дропах доменной зоны

Параметры:

  • zone
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет

/api/bill

Сведения о балансе, средств, кол-ве оставшихся запросов, дате следующего списания и т.д.

Параметры:

  • token
  • - Тип: string
  • - Обязательный: Нет
  • - По умолчанию: Нет