Документация и краткое руководство по API доменов NiceNIC v2
API доменов версии 2 от NiceNIC доступен как для розничных аккаунтов, так и для аккаунтов реселлеров. Используйте этот обзор, чтобы настроить доступ, подтвердить первый запрос, ознакомиться с моделью ответов API и сразу перейти к нужному разделу в левом меню навигации.
Аккаунт Маркет: доступ к API по ценам аккаунта Маркет.
Аккаунт реселлера: доступ к API по ценам, назначенным для текущего уровня реселлера.
Сравнить уровни реселлеров и цены →
Протестируйте интеграцию перед запуском
Используйте песочницу NiceNIC API для тестирования интеграции с API доменов перед переходом в рабочую среду. Проверяйте аутентификацию, запросы к API, обработку ответов и рабочий процесс вашего приложения в выделенной тестовой среде.
Идеально подходит для реселлеров, хостинг-провайдеров, разработчиков и платформ, подготавливающих интеграцию с API.
Выполните первый вызов API за 4 шагов
Начните с запроса только на чтение, прежде чем активировать действующие операции регистрации, продления или переноса. Это позволит проверить аутентификацию, формат запросов и обработку ответов без размещения платного заказа.
Включить доступ к API
Откройте «Настройки API», создайте или скопируйте свой API Secret и настройте разрешенные IP-адреса серверов, где это применимо.
Подтвердить аутентификацию
Используйте HTTPS с заголовком Authorization в формате username:api_secret.
Выполнить безопасный тест
Начните с проверки доступности доменов, расчета стоимости, баланса аккаунта или списка доменов.
Обработка ответа
Считывайте и сохраняйте возвращаемые code и msg перед запуском платных операций в производственной среде.
Рекомендуемый первый запрос: доступность домена
Эндпоинт проверки доступности поддерживает отправку нескольких доменов в одном запросе с разделением доменных имен запятыми.
Выберите нужный рабочий процесс
Приведенный ниже обзор повторяет структуру левой панели навигации. Используйте его, чтобы определить нужный рабочий процесс, а затем перейдите на страницу соответствующего эндпоинта для просмотра параметров, примеров запросов и ответов.
| Раздел | Для чего используется | Задокументированные функции |
|---|---|---|
| Начало работы | Безопасное подключение и принципы обработки ответов. | Обзор API, Песочница API, Аутентификация, Коды ответов. |
| Управление доменами | Автоматизируйте базовый жизненный цикл доменов. | Проверка доступности, список доменов, данные домена, регистрация, продление, входящий перенос, серверы имен, контакты, цены. |
| Злоупотребления и комплаенс | Отслеживайте домены, требующие внимания в рамках соответствия правилам (комплаенс). | Получение списка доменов с жалобами на нарушения, а также машиночитаемого статуса нарушений, жизненного цикла блокировки, информации о жалобе и рекомендуемых действий. |
| DNS-записи | Программное управление размещенными записями DNS. | Просмотр, создание, обновление и удаление DNS-записей. |
| Дочерние серверы имен | Управляйте хост-записями / glue-записями для серверов имен в вашем собственном домене. | Создание, просмотр списка, обновление и удаление дочерних серверов имен. |
| Аккаунт и оплата | Подключите автоматизацию к проверкам на уровне аккаунта. | Баланс аккаунта и связанная с транзакциями информация об аккаунте. |
| WHMCS API | Интегрируйте NiceNIC в существующий биллинговый процесс WHMCS. | Проверка доступности, Регистрация, Продление, Трансфер, Данные домена, Серверы имен, Контакты и дополнительные функции модуля регистратора. |
| Часто задаваемые вопросы по API | Решение распространенных вопросов по доступу, безопасности, тестированию и рабочим процессам. | Требования, учетные данные, обработка запросов, поддерживаемые операции и руководство по интеграции. |
Рекомендуемая начальная последовательность интеграции
Надежная рабочая интеграция должна проверять доступ и условия покупки до отправки реальных клиентских заказов.
Секретный ключ API + разрешенный IP
Тест подключения только для чтения
Запрос актуальной стоимости на уровне аккаунта
Проверьте наличие средств для платных операций
Обработка code + msg
Регистрация / Продление / Перенос
Разберитесь в успешных ответах, ответах в обработке и ответах с ошибками
code: 0 — Успешный ответ В примерах текущего эндпоинта код 0 используется для успешно выполненных ответов.
code: 201 — Заказ в обработке В документации по регистрации и переносу может возвращаться код 201, если заказ отправлен, но окончательная обработка еще ожидается.
code: 400 — Ошибка запроса В примерах эндпоинта код 400 используется для ошибок в параметрах запроса.
Поведение при ожидании регистрации
В текущей документации по регистрации доменов указано, что ответ 201 означает успешную отправку заказа и списание средств, однако окончательная активация зависит от подтверждения реестром. Если домен не удается активировать, стоимость регистрации возвращается на баланс аккаунта NiceNIC в течение 24 часов.
Поведение при ожидании трансфера
Конечная точка переноса также документирует 201 как заказ в обработке. Поэтому ваше приложение должно рассматривать ожидающий перенос как принятый в обработку, а не как подтверждение того, что перенос уже завершен.
Запрашивайте цены перед платными операциями
Эндпоинт цен NiceNIC позволяет получать стоимость регистрации, продления и переноса домена. Документированные значения type: register, renew, transfer и all. Документированный период составляет от 1 до 10 лет, возможны исключения для отдельных TLD.
Ответы с тарифами на регистрацию также могут возвращать флаг is_premium. Используйте эндпоинт цен перед отправкой платного запроса, если вашему приложению необходимо знать текущую стоимость на уровне аккаунта.
Узнайте разницу между серверами имен, DNS-записями и дочерними серверами имен
| Операция | Когда использовать | Документированная возможность |
|---|---|---|
| Обновить серверы имен | Вы хотите делегировать домен на другие авторитетные серверы имен. | Конечная точка серверов имен домена поддерживает первичный, вторичный и дополнительные серверы имен; на текущей странице указано ограничение до шести серверов. |
| DNS-записи | Вы используете DNS-хостинг NiceNIC, и вам необходимо управлять записями зоны. | Для вывода списка, создания, обновления и удаления записей DNS задокументированы отдельные API. |
| Дочерние серверы имен | Вам требуются хост- / glue-записи, такие как ns1.example.com. |
Создание, просмотр списка, обновление и удаление дочерних серверов имен. Эндпоинт создания требует, чтобы имя хоста сервера имен соответствовало домену, и принимает IP-адрес. |
Автоматизируйте мониторинг портфолио, а не только заказы доменов
API доменов версии 2 также включает операции чтения, полезные после регистрации. Конечная точка «Список доменов» поддерживает пагинацию, сортировку, фильтрацию по статусу и блокировке, а «Сведения о домене» возвращает даты регистрации и истечения срока действия, серверы имен и контактные данные регистранта.
Мониторинг нарушений и соответствия правилам
Abuse & Compliance API от NiceNIC позволяет получать список доменов с жалобами на нарушения и подробную машиночитаемую сводку по конкретному домену. Эндпоинт детализации нарушений документирует шесть статусов уровня домена: Normal, Under Review, Pending ClientHold, ClientHold, Closed и ServerHold.
Ответ может включать текущее влияние, рекомендуемое следующее действие, статус и график блокировки, количество жалоб, даты жалоб, категории, классификацию DNS-abuse, статус доказательств и указанные в отчетах URL-адреса (где применимо). Это позволяет платформам и реселлерам отображать статус соответствия требованиям в собственных рабочих системах, не полагаясь только на ручную проверку.
Выберите модель интеграции, подходящую для вашей системы
| Опция | Лучше всего подходит для | Что предоставляет текущая документация |
|---|---|---|
| API для доменов v2 | Пользовательские сайты, SaaS-платформы, внутренние системы, индивидуальные процессы биллинга или автоматического предоставления услуг. | Прямая интеграция через HTTPS + JSON для операций с доменами, DNS, дочерними серверами имен, аккаунтами и проверкой соответствия требованиям. |
| Модуль WHMCS | Хостинг-компании и реселлеры, которые уже используют WHMCS. | Доступность, регистрация, продление, перенос, данные домена, серверы имен, контакты, блокировка/разблокировка, получение EPP, ведение журнала ошибок и дополнительный тестовый режим. |
В актуальной документации WHMCS в качестве требований указаны WHMCS 7.0 или выше, PHP 7.0 или выше с cURL, действительные учетные данные NiceNIC API и поддержка SSL/TLS.
В случае сбоя запроса к API
Отталкивайтесь от возвращенного ответа и состояния конфигурации, вместо того чтобы повторно выполнять одно и то же платное действие.
Ошибка аутентификации или доступа
- Подтвердите имя пользователя NiceNIC и секретный ключ API.
- Убедитесь, что заголовок Authorization указан и правильно отформатирован.
- Убедитесь, что API Secret не был сброшен или обновлен.
- Если включены ограничения по IP, убедитесь, что запрос поступает с авторизованного исходящего IP-адреса сервера.
Ошибка параметра запроса
- Сравните запрос с задокументированными параметрами конкретного эндпоинта.
- Проверьте обязательные значения, форматы и названия действий.
- Проверьте периоды регистрации для конкретных TLD или требования к контактам, где применимо.
Платная операция выполняется не сразу
- Проверьте возвращенные
codeиmsg. - Не считайте ответ
201со статусом ожидания окончательным завершением. - Подтвердите баланс аккаунта и текущие цены перед повторной попыткой платного действия.
Нужна поддержка NiceNIC
- Зафиксируйте временную метку запроса и действие API.
- Укажите соответствующее доменное имя или объект, если применимо.
- Укажите возвращенный код и сообщение.
- Передавайте только неконфиденциальные параметры; никогда не публикуйте полный API Secret в тикете.
Начните с безопасного тестового запроса
Включите доступ к API, подтвердите аутентификацию, выполните тестовый запрос доступности или стоимости и проверьте обработку ответов перед запуском платных операций для клиентов.






