Обзор API
Документация и быстрый старт по API v2 NiceNIC для доменов
API v2 NiceNIC для доменов доступен как для розничных аккаунтов, так и для аккаунтов реселлеров. Используйте этот обзор, чтобы настроить доступ, проверить первый запрос, разобраться в модели ответов API и перейти к нужному разделу в меню слева.
Доступ к API и цены для реселлеров — отдельные условия.
Розничный аккаунт: доступ к API с розничными ценами.
Аккаунт реселлера: доступ к API с ценами, установленными для текущего уровня реселлера.
Compare reseller levels and pricing →
Розничный аккаунт: доступ к API с розничными ценами.
Аккаунт реселлера: доступ к API с ценами, установленными для текущего уровня реселлера.
Compare reseller levels and pricing →
Базовый адрес
https://api.nicenic.net/v2/
Обязательные заголовки
Host: api.nicenic.net Authorization: username:api_secret Content-Type: application/json
Стандартный успешный ответ
{ "code": 0, "msg": "успешно", "data": {} }
API-песочница
Проверьте свою интеграцию перед запуском
Используйте API-песочницу NiceNIC для тестирования интеграции с API для доменов перед переходом в рабочую среду. Проверьте аутентификацию, запросы к API, обработку ответов и рабочий процесс вашего приложения в выделенной тестовой среде.
Идеально подходит для реселлеров, хостинг-провайдеров, разработчиков и платформ, подготавливающих интеграцию с API.
Быстрый старт
Выполните свой первый вызов API за 4 шага
Начните с запроса только для чтения, прежде чем активировать регистрацию, продление или передачу доменов в реальном времени. Это позволит вам проверить аутентификацию, форматирование запросов и обработку ответов без необходимости размещать платный заказ.
1
Включить доступ к API
Откройте настройки API, создайте или получите секрет API и настройте IP-адреса авторизованных серверов, если применимо.
2
Подтверждение аутентификации
Используйте HTTPS с заголовком Authorization в формате username:api_secret.
3
Проведите безопасный тест
Начните с доступности домена, цен, баланса счета или списка доменов.
4
Обработка ответа
Перед активацией платных производственных операций прочитайте и сохраните возвращенные code и msg.
Рекомендуемый первый запрос: проверка доступности домена
Конечная точка проверки доступности поддерживает несколько доменов в одном запросе, разделяя имена доменов запятыми.
curl "https://api.nicenic.net/v2/?category=domain&action=check&domains=example.com,example.net" \ -H "Authorization: username:api_secret" \ -H "Content-Type: application/json"
Карта API
Выберите нужный рабочий процесс
Приведённый ниже обзор соответствует левой навигации. Используйте его, чтобы определить правильный рабочий процесс, затем откройте соответствующую страницу конечной точки для получения параметров, примеров запросов и ответов.
| Раздел | Использование | Документированные функции |
|---|---|---|
| Начало работы | Безопасное подключение и понимание обработки ответов | Обзор API, тестовая среда API, аутентификация, коды ответов. |
| Управление доменами | Автоматизация основного жизненного цикла домена | Проверка доступности, Список доменов, Детали домена, Регистрация, Продление, Перенос, Серверы имен, Контакты, Цены |
| Злоупотребления и соответствие требованиям | Мониторинг доменов, требующих внимания по соответствию требованиям | Список доменов с отчетами о злоупотреблениях, машиночитаемый статус злоупотреблений, жизненный цикл блокировки, информация о жалобах, рекомендуемые действия |
| DNS-записи | Управляйте размещенными DNS-записями программно. | Просмотр, создание, обновление и удаление DNS-записей. |
| Дочерние серверы имён | Управляйте записями хоста и связующими записями для серверов имён в своем домене. | Создание, просмотр, обновление и удаление дочерних серверов имён. |
| Аккаунт и оплата | Подключите автоматизацию к проверкам на уровне аккаунта. | Баланс аккаунта и информация о транзакциях по аккаунту. |
| WHMCS API | Интегрируйте NiceNIC в существующий рабочий процесс биллинга WHMCS. | Проверка доступности, регистрация, продление, перенос, информация о домене, серверы имён, контакты и дополнительные функции модуля регистратора. |
| Вопросы и ответы по API | Решайте общие вопросы по доступу, безопасности, тестированию и рабочим процессам | Критерии отбора, учетные данные, обработка запросов, поддерживаемые операции и руководство по интеграции |
Рекомендуемый рабочий процесс
Рекомендуемая последовательность первой интеграции
Надежная интеграция в рабочей среде должна проверять условия доступа и покупки, прежде чем начать отправку заказов реальных клиентов.
1. Аутентификация
API-секрет + авторизованный IP
API-секрет + авторизованный IP
→
2. Доступность
Тест подключения только для чтения
Тест подключения только для чтения
→
3. Ценообразование
Запрос текущей стоимости аккаунта
Запрос текущей стоимости аккаунта
→
4. Баланс
Подтверждение средств для платных операций
Подтверждение средств для платных операций
→
5. Обработка ответа
Обработка кода и сообщения
Обработка кода и сообщения
→
6. Рабочие операции
Регистрация / Продление / Трансфер
Регистрация / Продление / Трансфер
Не считайте, что API-запрос выполнен только потому, что он был принят. Некоторые операции могут вернуть статус ожидания и по-прежнему требовать обработки в реестре, прежде чем будет подтверждено окончательное состояние домена.
Поведение в рабочей среде
Понимание успешных, ожидающих и ошибочных ответов
code: 0 — Успешный ответ Текущие примеры конечных точек используют код 0 для успешно завершённых ответов.
code: 201 — Ожидающий заказ Документация по регистрации и передаче может возвращать код 201, когда заказ отправлен, но окончательная обработка еще ожидается.
code: 400 — Ошибка запроса Примеры конечных точек используют код 400 для ошибок параметров запроса.
Поведение при ожидании регистрации
В текущей документации по регистрации доменов указано, что ответ 201 означает успешную отправку заказа и списание платы, однако окончательная активация всё ещё зависит от подтверждения реестром. Если домен не может быть активирован, регистрационная плата возвращается на баланс счёта NiceNIC в течение 24 часов.
Поведение при ожидании трансфера
Эндпоинт трансфера также документирует 201 как ожидающий заказ. Поэтому ваше приложение должно рассматривать ожидающий трансфер как принятый к обработке, а не как подтверждение того, что трансфер уже завершен.
Цены
Запрос цен до платных операций
Эндпоинт ценообразования NiceNIC позволяет получать цены на регистрацию, продление и передачу домена. Документированные значения type: register, renew, transfer и all. Документированный период — от 1 до 10 лет, возможны исключения для конкретных TLD.
Ответы о ценах на регистрацию могут также возвращать флаг is_premium. Используйте конечную точку для получения цен перед отправкой платного запроса, когда вашему приложению необходимо знать текущую стоимость на уровне аккаунта.
Бесплатный доступ к API не меняет ваш тарифный уровень. Для розничных аккаунтов действуют розничные цены; для аккаунтов реселлеров — цены, установленные для их текущего уровня.
Операции с доменами и DNS
Узнайте разницу между серверами имён, DNS-записями и дочерними серверами имён
| Операция | Когда использовать | Документированная возможность |
|---|---|---|
| Обновить серверы имён | Вы хотите делегировать домен на другие авторитетные серверы имён. | Конечная точка сервера имён домена поддерживает первичные, вторичные и дополнительные серверы имён, при этом на текущей странице документируется ограничение до шести серверов. |
| DNS-записи | Вы используете хостинг DNS от NiceNIC и вам необходимо управлять записями зон. | Отдельные API документированы для перечисления, создания, обновления и удаления DNS-записей. |
| Дочерние серверы имён | Вам потребуются хост-записи / глю-записи, такие как ns1.example.com. |
Создание, просмотр, обновление и удаление дочерних серверов имен. Конечная точка создания требует, чтобы имя хоста сервера имен совпадало с доменом, и принимает IP-адрес. |
Портфель и комплаенс
Автоматизируйте мониторинг портфеля, а не только заказы доменов
API v2 для доменов также включает операции чтения, полезные после регистрации. Метод получения списка доменов поддерживает разбиение на страницы, сортировку, фильтрацию по статусу и наличию блокировки, а метод получения сведений о домене возвращает даты регистрации и окончания срока действия, серверы имён и контактную информацию регистранта.
Мониторинг злоупотреблений и соответствия требованиям
API злоупотреблений и соответствия NiceNIC может выводить список доменов с жалобами и возвращать подробную машиночитаемую сводку по конкретному домену. Документация по конечной точке подробных сведений о злоупотреблениях описывает шесть статусных фраз на уровне домена: Нормальный, На рассмотрении, Ожидает ClientHold, ClientHold, Закрыт и ServerHold.
Ответ может включать текущее влияние, рекомендуемое следующее действие, состояние удержания и сроки, количество жалоб, даты жалоб, категории, классификацию злоупотреблений DNS, статус доказательств и сообщенные URL-адреса, где применимо. Это позволяет платформам и реселлерам отображать статус соответствия в своих собственных операционных системах, а не полагаться только на ручную проверку.
Прямой API или WHMCS
Выберите модель интеграции, подходящую для вашей системы
| Вариант | Лучше всего для | Что предоставляет текущая документация |
|---|---|---|
| API v2 для доменов | Индивидуальные веб-сайты, SaaS-платформы, внутренние системы, настраиваемые процессы биллинга или предоставления услуг. | Прямая интеграция через HTTPS и JSON для доменов, DNS, дочерних серверов имен, аккаунтов и соблюдения требований. |
| Модуль WHMCS | Хостинг-компании и реселлеры, которые уже используют WHMCS. | Проверка доступности, регистрация, продление, трансфер, детали домена, серверы имен, контакты, блокировка/разблокировка, получение EPP, журнал ошибок и опциональный тестовый режим. |
Текущая документация WHMCS перечисляет в качестве требований WHMCS 7.0 или выше, PHP 7.0 или выше с cURL, действующие учетные данные API NiceNIC и поддержку SSL/TLS.
Устранение неполадок
При ошибке запроса API
Начните с возвращённого ответа и состояния конфигурации, а не повторяйте одно и то же оплаченное действие многократно.
Ошибка аутентификации или доступа
- Проверьте имя пользователя NiceNIC и секретный ключ API.
- Убедитесь, что заголовок Authorization присутствует и правильно отформатирован.
- Убедитесь, что секретный ключ API не был сброшен или изменён.
- Если включены ограничения по IP, убедитесь, что запрос отправляется с авторизованного исходящего IP-адреса сервера.
Ошибка параметров запроса
- Сравните запрос с документированными параметрами конкретной конечной точки.
- Проверьте обязательные значения, форматы и названия действий.
- Проверьте периоды регистрации или требования к контактам для конкретных TLD, если применимо.
Платная операция не завершается немедленно
- Прочтите возвращенные
codeиmsg. - Не рассматривайте ответ с кодом
201в состоянии ожидания как окончательное завершение. - Перед повторением платного действия проверьте баланс счета и текущие цены.
Нужна поддержка NiceNIC
- Запишите метку времени запроса и действие API.
- При необходимости укажите доменное имя или задействованный объект.
- Включите возвращённый код и сообщение.
- Сообщайте только неконфиденциальные параметры; никогда не публикуйте полный секрет API в тикете.
Следующий шаг
Начните с безопасного тестового запроса
Включите доступ к API, подтвердите аутентификацию, выполните запрос на доступность или цены и проверьте обработку ответов, прежде чем включать платные операции для клиентов.
Последняя проверка: 26 августа 2026 г.
