API

Регистрация переводов, проверка доступности, DNS и управление в ваших собственных системах: оптовые заказы, обновления, панель управления для ваших клиентов.

API — это точка входа машины для тех же операций, которые предлагает клиентская область. Все, что вы можете сделать на странице, вы можете написать в сценарии.

ОТДЫХ HTTPS с ответами JSON

Ключи API Создается и отзывается в клиентской зоне

Полное покрытие Те же операции, что и в клиентской зоне

проверяемый Звонки записываются на счет

Что это такое

Конечные точки группируются по ресурсам — доступности, доменам, серверам имен, контактам, заказам и счетам — и возвращают JSON.
Для аутентификации используется ключ API, сгенерированный в клиентской области, который можно отозвать и заменить в любое время.
Типичное использование: массовая регистрация, проверка истечения срока действия, синхронизация состояния домена с вашей собственной системой, панель самообслуживания для клиентов и автоматизированные рабочие процессы сертификатов.
Применяются те же бизнес-правила, что и в Интернете: домен не может быть зарегистрирован из воздуха, а для передачи по-прежнему требуется разблокированный домен и 60 дней.

Как это работает

01

Создать ключ

Создайте ключ API в клиентской области с указанием того, что ему нужно делать.

02

Прочтите документацию

Конечные точки, параметры и формы ответа.

03

Тест небольшой

Прежде чем автоматизировать, попробуйте конечные точки только для чтения или пару доменов.

04

Начните работу с журналированием

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

Наличие и поиск

Проверьте сразу несколько имен для мониторинга и выбора.

Регистрация и продление

Заказать, продлить и прочитать статус заказа.

DNS и серверы имен

Массовая отправка записей и изменений серверов имен.

Управление контактами

Прочтите и обновите информацию о владельце регистрации, администраторе, технических специалистах и платежах.

Заказы и счета

Чтение заказов, счетов-фактур и статуса оплаты.

Ключевое вращение

Отзыв и замена ключей; держите каждую систему на своем собственном ключе.

Что охватывает API

По ресурсу

Ресурс	Что вы можете сделать
Домены	Проверить доступность, зарегистрироваться, продлить, прочитать статус и срок действия
DNS	Чтение и настройка серверов имен, ведение записей DNS.
Конфиденциальность и контакты	Установите уровень конфиденциальности, обновите все четыре роли контактов.
Заказы и выставление счетов	Чтение заказов, счетов-фактур и статуса оплаты
Аккаунт	Прочитайте баланс и основные данные счета

Что необходимо иметь перед подключением

Четыре мелочи, которые избавляют от большей части отладки

Баланс или рабочий способ оплаты: регистрация и продление являются реальными заказами, а звонок на этапе заказа не будет выполнен без средств.
Повторные попытки и обработка ошибок: возникают сбои в сети, ограничения скорости и задержки в восходящем направлении. Повторить идемпотентное чтение; для заказов отправьте уникальную ссылку и проверьте, прежде чем писать снова.
Ведение журнала: записывайте ссылку, домен и код ответа. Если позже что-то будет оспариваться, эти журналы будут единственным доказательством того, что действие произошло.
Наименьшие привилегии: не используйте ключ с возможностью записи для задания, доступного только для чтения, и дайте каждой системе собственный ключ, чтобы один из них можно было отозвать, не нарушая работу других.

Ключ API эквивалентен паролю учетной записи. Храните его в переменной среды на стороне сервера или в диспетчере секретов, а не во внешнем коде и никогда в репозитории.

Как люди это используют

Общие шаблоны

Массовая регистрация: отправьте выборку для регистрации и запишите результаты обратно в свою серверную часть.
Продление продления: каждую ночь извлекайте домены, срок действия которых истекает, и создайте собственные напоминания или задачи продления.
Панели White-label: позвольте вашим клиентам управлять доменами внутри вашего продукта, не входя в систему здесь.
Сверка: извлекайте данные о домене и заказе по расписанию и сопоставляйте их со своим собственным реестром.

Что включает в себя каждый заказ

API Управление ключами

Создавайте, отзывайте и разделяйте ключи по назначению.

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

Конечные точки, параметры и ответы.

Конечные точки домена и DNS

Поиск, регистрация, продление DNS и серверов имен.

Конечные точки заказов и выставления счетов

Заказы, счета и статус оплаты.

История звонков

Записывается в учетную запись для устранения неполадок.

Поддержка

Откройте заявку, если интеграция работает неправильно.

Общие вопросы

Взимается ли дополнительная плата за API?

Сам API отдельно не взимается; вы платите за выполняемые им бизнес-операции. Существует разумное ограничение скорости для предотвращения случайного или неправомерного использования.

Есть ли SDK?

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

Что делать, если ключ протечет?

Отмените его в клиентской области и создайте новый. Отзыв вступает в силу немедленно, а запросы с использованием старого ключа отклоняются.

Тестирование ничего не стоит?

Вызовы только для чтения ничего не стоят. Регистрация и продление — это реальные заказы и требуют денег, поэтому сначала проверьте логику на небольшом количестве доменов.

Может ли API управлять доменами, зарегистрированными в другом месте?

Нет. Он работает с доменами в этом аккаунте точно так же, как и клиентский кабинет.

Обратите внимание

Храните ключи API на сервере. Ключ, поставляемый в коде браузера или мобильном пакете, является опубликованным ключом.
Для заказа конечных точек отправьте уникальную ссылку на запрос и проверьте ее перед записью, чтобы повторная попытка сети не регистрировалась и не взималась плата дважды.