Часто задаваемые вопросы об API доменов NiceNIC версии 2

API доменов NiceNIC версии 2 — это API на базе HTTPS и JSON для автоматизации управления доменами через ваш аккаунт NiceNIC.

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

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

Любой активный аккаунт NiceNIC может использовать API доменов v2. Доступ к API открыт как для аккаунтов Маркета, так и для аккаунтов Реселлера.

Вам не обязательно становиться реселлером только ради получения доступа к API. Однако тип аккаунта по-прежнему влияет на ценообразование: для платных операций через API действуют цены, назначенные аккаунту NiceNIC, с которого отправлен запрос.

Открыть настройки API →

Да. Сам доступ к API предоставляется бесплатно. Отдельная плата за активацию доступа к API или отправку поддерживаемых запросов к API не взимается.

Платные операции, такие как регистрация, продление и трансфер домена, оплачиваются согласно ценам вашего аккаунта и применимым правилам доменной зоны.

Нет. Доступ к API и цены для реселлеров разделены.

Вы можете использовать API для доменов v2 с обычным аккаунтом NiceNIC Market. Переходить на статус аккаунта Реселлер имеет смысл только тогда, когда партнерские цены или другие преимущества для реселлеров выгодны для объемов вашего бизнеса.

Сравнить тарифы для реселлеров →

API доменов версии 2 использует актуальную структуру API NiceNIC с HTTPS-запросами, JSON-ответами, аутентификацией на основе заголовков и документацией, организованной вокруг рабочих процессов для отдельных доменов и учетных записей.

Если у вас уже настроена интеграция на базе старой версии API NiceNIC, изучите параметры API v2 и правила обработки ответов перед переводом рабочего трафика, а не рассчитывайте на полную взаимозаменяемость двух версий.

Войдите в свой аккаунт NiceNIC и откройте Настройки API. В запросах API v2 для аутентификации используются ваше имя пользователя NiceNIC и секретный ключ API.

Открыть настройки API →

Да. NiceNIC предоставляет песочницу API, позволяющую разработчикам тестировать интеграции перед их подключением к рабочему API.

Используйте песочницу для проверки аутентификации, форматирования запросов, парсинга ответов, обработки ошибок и рабочего процесса вашего приложения перед включением реальных операций с доменами клиентов.

Открыть песочницу API →

Песочница API предназначена для разработки и тестирования интеграции. Рабочий API используется для реальных операций с доменами и платных запросов к вашему аккаунту NiceNIC.

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

Отправляйте запросы к API по протоколу HTTPS и указывайте имя пользователя NiceNIC и API Secret в заголовке Authorization.

Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/json

Если для вашего аккаунта включены ограничения по IP, запросы также должны отправляться с разрешенного IP-адреса сервера.

Читать об аутентификации API →

Базовый адрес рабочей среды API:

https://api.nicenic.net/v2/

Действия API выбираются с помощью параметров, описанных для каждого эндпоинта, таких как category и action. Всегда сверяйтесь со специальной документацией по эндпоинту, чтобы узнать обязательные и необязательные параметры конкретной операции.

Ответы API v2 возвращаются в формате JSON, а параметры запросов используют кодировку UTF-8.

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Ваше приложение должно проверять возвращаемые поля code и msg, а не считать любой успешный HTTP-ответ подтверждением завершенной операции с доменом.

С помощью документированных API вы можете автоматизировать рабочие процессы, включая проверку доступности доменов, регистрацию, продление и трансфер, вывод списка портфолио и сведений о доменах, обновление серверов имен и контактов домена, получение цен на домены, DNS-записи, дочерние серверы имен (child nameservers), данные аккаунта, а также мониторинг жалоб и комплаенса (Abuse & Compliance).

Дополнительные рабочие процессы описаны отдельно в навигации по API.

Начните с низкорисковых операций чтения, таких как проверка доступности домена, цены на домены, баланс аккаунта и получение списка доменов.

Затем подтвердите аутентификацию, парсинг ответов, обработку ошибок и обработку заказов в состоянии ожидания перед включением реальных регистраций, продлений или трансферов.

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

example.com,example.net,example.org

Не предполагайте, что каждая операция API поддерживает одинаковый формат ввода для нескольких доменов. Регистрация, продление и трансфер должны следовать документации соответствующих эндпоинтов.

Используйте конечную точку Get Domain Pricing. Документированные типы цен включают register, renew, transfer и all.

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

Поскольку заказы через API рассчитываются по ценам вашего аккаунта, запрашивайте актуальные цены перед отправкой платных клиентских заказов, а не полагайтесь постоянно на кэшированные данные.

Нет. Хотя документация API допускает периоды до 1–10 лет для применимых зон, у отдельных TLD могут действовать свои правила реестров.

Сроки регистрации, периоды продления, условия переноса, требования к контактным данным и проверке могут различаться в зависимости от доменной зоны. Ваше приложение должно учитывать актуальные правила для соответствующего TLD.

Это разные операции, и их нельзя считать взаимозаменяемыми.

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

Посмотреть коды ответов API →

Ответ 201 означает, что операция принята в обработку, но ее выполнение еще не обязательно завершено.

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

Не сообщайте конечному клиенту, что домен активен, пока ваша система не подтвердит окончательный результат. Ознакомьтесь с документацией эндпоинта регистрации, чтобы узнать актуальные правила обработки заказов в статусе ожидания и возврата средств.

Статус ожидания (pending) трансфера означает, что запрос на трансфер принят в обработку, но сам перенос домена в NiceNIC еще не завершен.

Завершение трансфера может зависеть от обработки реестром и регистратором, а также от текущего статуса трансфера домена. Оставляйте трансфер в статусе ожидания (pending) до подтверждения завершения.

Да. API списка доменов поддерживает получение портфеля с возможностями пагинации, сортировки и фильтрации.

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

API доменов NiceNIC версии 2 включает методы для работы с жалобами и соблюдением правил (Abuse & Compliance), разработанные для платформ и реселлеров, управляющих клиентскими портфолио доменов.

Вы можете выявлять домены, связанные с жалобами на нарушения (abuse reports), и получать машиночитаемую информацию о соответствии правилам для отдельных доменов. В зависимости от ситуации ответ может содержать статус домена, текущие последствия, рекомендуемое действие, сведения о блокировке, информацию о жалобе и указанные URL-адреса нарушений.

Это позволяет отображать статус комплаенса непосредственно в вашем клиентском портале или операционной системе.

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

Используйте прямой API доменов версии 2 при разработке собственного приложения или рабочего процесса. Выбирайте интеграцию с WHMCS, если вам необходимо управлять доменными операциями в существующей среде WHMCS.

Посмотреть интеграцию с WHMCS →

Любой серверный язык программирования или среда выполнения, способные отправлять запросы HTTPS и обрабатывать JSON, могут быть интегрированы с API доменов версии 2.

Популярные варианты включают PHP, Python, Node.js и Java. Храните учетные данные API на стороне сервера и никогда не раскрывайте свой API Secret в JavaScript на стороне браузера или в загружаемом клиентском коде.

Для защиты стабильности API и безопасности платформы может применяться ограничение частоты запросов (rate limiting).

Если ожидается, что ваша рабочая интеграция будет создавать постоянный высокий объем запросов, свяжитесь с NiceNIC до запуска, чтобы согласовать ожидаемый профиль нагрузки.

Укажите метку времени запроса, категорию и действие API, доменное имя (если применимо), неконфиденциальные параметры запроса, возвращенный код ответа и сообщение, а также информацию о том, был ли запрос отправлен из песочницы или рабочей среды.

Отправить тикет →

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

В разделе FAQ описывается общее поведение API; первоисточником точного формата запросов всегда является документация конкретных конечных точек.

Открыть документацию API →