Документація NiceNIC Domain API v2 та швидкий старт
NiceNIC Domain API v2 доступний як для облікових записів Market, так і для облікових записів Reseller. Використовуйте цей огляд, щоб налаштувати доступ, підтвердити перший запит, зрозуміти модель відповідей API та перейти безпосередньо до відповідного розділу в лівій навігації.
Market акаунт: доступ до API з цінами Market акаунта.
Reseller акаунт: доступ до API з цінами, призначеними для поточного рівня реселера.
Порівняти рівні та ціни для реселерів →
Перевірте свою інтеграцію перед запуском
Використовуйте тестове середовище API NiceNIC, щоб перевірити інтеграцію API для доменів перед переходом у продакшн. Перевірте автентифікацію, API-запити, обробку відповідей та робочий процес вашого застосунку в спеціалізованому тестовому середовищі.
Ідеально підходить для реселерів, хостинг-провайдерів, розробників і платформ, які готують інтеграцію API.
Зробіть свій перший API-виклик за 4 кроки
Почніть із запиту лише для читання, перш ніж увімкнути реальні реєстрації, продовження або трансфери. Це дозволяє перевірити автентифікацію, форматування запитів та обробку відповідей без розміщення платного замовлення.
Увімкнути доступ до API
Відкрийте налаштування API, створіть або отримайте ваш секретний ключ API та налаштуйте авторизовані IP-адреси серверів, якщо це застосовно.
Підтвердження автентифікації
Використовуйте HTTPS із заголовком Authorization у форматі username:api_secret.
Проведіть безпечний тест
Почніть з доступності домену, цін, балансу облікового запису або списку доменів.
Обробка відповіді
Прочитайте та збережіть повернуті code та msg перед активацією платних виробничих дій.
Рекомендований перший запит: перевірка доступності домену
Кінцева точка перевірки доступності підтримує кілька доменів в одному запиті, якщо розділити назви доменів комами.
Оберіть потрібний робочий процес
Наведений нижче огляд відповідає лівій навігації. Скористайтеся ним, щоб визначити правильний робочий процес, а потім відкрийте сторінку відповідної кінцевої точки для перегляду параметрів, прикладів запитів і прикладів відповідей.
| Розділ | Призначення | Документовані функції |
|---|---|---|
| Початок роботи | Підключайтеся безпечно та розумійте обробку відповідей. | Огляд API, тестове середовище API, автентифікація, коди відповідей. |
| Управління доменами | Автоматизуйте основний життєвий цикл домену. | Доступність, перелік доменів, деталі домену, реєстрація, поновлення, передача, сервери імен, контакти, ціни. |
| Зловживання та відповідність | Відстежуйте домени, що потребують уваги з питань відповідності. | Отримуйте перелік доменів зі звітами про зловживання та доступ до машиночитаного статусу зловживання, життєвого циклу блокування, інформації про скарги та рекомендованих дій. |
| DNS-записи | Керуйте розміщеними DNS-записами програмним способом. | Перегляд, створення, оновлення та видалення DNS-записів. |
| Дочірні сервери імен | Керуйте записами host / glue для серверів імен у вашому власному домені. | Створення, перегляд, оновлення та видалення дочірніх серверів імен. |
| Акаунт та оплата | Підключіть автоматизацію до перевірок на рівні облікового запису. | Баланс облікового запису та інформація про транзакції. |
| WHMCS API | Інтегруйте NiceNIC у наявний робочий процес білінгу WHMCS. | Доступність, реєстрація, продовження, передача, деталі домену, сервери імен, контакти та додаткові функції модуля реєстратора. |
| Поширені запитання API | Вирішуйте поширені питання доступу, безпеки, тестування та робочого процесу. | Право на використання, облікові дані, обробка запитів, підтримувані операції та рекомендації щодо інтеграції. |
Рекомендована послідовність першої інтеграції
Надійна інтеграція для виробничого середовища має перевіряти умови доступу та придбання, перш ніж надсилати реальні замовлення клієнтів.
API Secret + авторизована IP-адреса
Тест підключення лише для читання
Запит поточної вартості для облікового запису
Підтвердження коштів для платних дій
Опрацювання коду та повідомлення
Реєстрація / Поновлення / Передача
Розуміння успішних, відкладених та помилкових відповідей
code: 0 — Успішна відповідь У прикладах поточних кінцевих точок code 0 означає успішно завершену відповідь.
code: 201 — Відкладене замовлення Документація щодо реєстрації та передачі може повертати code 201, коли замовлення подано, але остаточна обробка ще триває.
code: 400 — Помилка запиту У прикладах кінцевих точок code 400 означає помилку параметрів запиту.
Поведінка при очікуванні реєстрації
Щодо реєстрації доменів, поточна документація зазначає, що відповідь 201 означає, що замовлення було успішно подано, а плату списано, однак остаточна активація все ще залежить від підтвердження реєстратора. Якщо домен неможливо активувати, реєстраційний внесок повертається на баланс облікового запису NiceNIC протягом 24 годин.
Поведінка при очікуваному перенесенні
Кінцева точка перенесення також документує 201 як замовлення в очікуванні. Тому ваш додаток має розглядати очікуване перенесення як прийняте для обробки, а не як підтвердження того, що перенесення вже завершено.
Перевірте ціни перед платними операціями
Ціновий ендпоінт NiceNIC може отримувати ціни на реєстрацію, продовження та передачу домену. Документовані значення type: register, renew, transfer та all. Документований період — від 1 до 10 років, можливі винятки для окремих TLD.
Відповіді щодо цін на реєстрацію також можуть містити прапорець is_premium. Використовуйте ціновий ендпоінт перед надсиланням платного запиту, якщо вашому застосунку потрібно знати поточну вартість для вашого облікового запису.
Дізнайтеся про різницю між серверами імен, DNS-записами та дочірніми серверами імен
| Операція | Коли використовувати | Документована можливість |
|---|---|---|
| Оновити сервери імен | Ви хочете делегувати домен іншим авторитетним серверам імен. | Кінцева точка доменних серверів імен підтримує первинний, вторинний та додаткові сервери, при цьому поточна сторінка документує обмеження до шести. |
| DNS-записи | Ви використовуєте хостинг DNS від NiceNIC і потребуєте керувати записами зони. | Окремо задокументовані API для перегляду, створення, оновлення та видалення DNS-записів. |
| Дочірні сервери імен | Вам потрібні хост-записи / glue-записи, наприклад ns1.example.com. |
Створюйте, перелічуйте, оновлюйте та видаляйте дочірні сервери імен. Кінцева точка створення вимагає, щоб ім'я хоста сервера імен відповідало домену, і приймає IP-адресу. |
Автоматизуйте моніторинг портфеля, а не лише замовлення доменів
Domain API v2 також включає операції читання, які корисні після реєстрації. Кінцева точка List Domains підтримує посторінкову розбивку, сортування, фільтрацію за статусом та фільтрацію за утриманням, а Get Domain Details повертає дати реєстрації, дати закінчення терміну дії, сервери імен та контактні дані реєстранта.
Моніторинг зловживань і відповідності
API зловживань і відповідності NiceNIC може перелічувати домени зі звітами про зловживання та повертати детальну машиночитану зведену інформацію для конкретного домену. Детальна кінцева точка зловживань документує шість статусних фраз рівня домену: Normal, Under Review, Pending ClientHold, ClientHold, Closed і ServerHold.
Відповідь може містити поточний вплив, рекомендовану наступну дію, стан утримання та часову шкалу, кількість скарг, дати скарг, категорії, класифікацію DNS-зловживань, статус доказів і зазначені URL-адреси, якщо застосовно. Це дозволяє платформам і реселерам відображати статус відповідності у власних операційних системах, не покладаючись лише на ручну перевірку.
Оберіть модель інтеграції, яка відповідає вашій системі
| Варіант | Для кого | Що надає поточна документація |
|---|---|---|
| Domain API v2 | Власні вебсайти, SaaS-платформи, внутрішні системи, власні процеси білінгу або надання послуг. | Пряма інтеграція через HTTPS + JSON для операцій із доменами, DNS, дитячими серверами імен, акаунтами та комплаєнсом. |
| Модуль WHMCS | Хостинг-компанії та реселери, які вже використовують WHMCS. | Перевірка доступності, реєстрація, продовження, трансфер, деталі домену, сервери імен, контакти, блокування/розблокування, отримання EPP, журналювання помилок і додатковий тестовий режим. |
Поточна документація WHMCS перелічує такі вимоги: WHMCS 7.0 або вище, PHP 7.0 або вище з cURL, дійсні облікові дані API NiceNIC та підтримка SSL/TLS.
Коли запит до API завершується помилкою
Почніть із отриманої відповіді та стану конфігурації, а не повторюйте ту саму платну дію багаторазово.
Помилка автентифікації або доступу
- Перевірте ім’я користувача NiceNIC та API Secret.
- Переконайтеся, що заголовок Authorization присутній і правильно відформатований.
- Переконайтеся, що API Secret не було скинуто або змінено.
- Якщо обмеження за IP увімкнено, підтвердьте, що запит надходить із авторизованої IP-адреси вихідного сервера.
Помилка параметрів запиту
- Порівняйте запит із задокументованими параметрами відповідної кінцевої точки.
- Переконайтеся, що обов'язкові значення, формати та назви дій вказано правильно.
- Перевірте періоди реєстрації або вимоги до контактів, специфічні для TLD, якщо це застосовно.
Платна операція не виконується миттєво
- Прочитайте повернуті
codeтаmsg. - Не вважайте відповідь
201остаточним завершенням. - Підтвердьте баланс рахунку та поточні ціни перед повторенням платної дії.
Потрібна підтримка NiceNIC
- Зафіксуйте час запиту та дію API.
- Зазначте відповідне доменне ім'я або об'єкт, якщо це застосовно.
- Включіть повернений код і повідомлення.
- Передавайте лише неконфіденційні параметри; ніколи не вказуйте повний секретний ключ API в заявці.
Почніть із безпечного тестового запиту
Увімкніть доступ до API, підтвердьте автентифікацію, виконайте запит наявності або ціни та перевірте обробку відповідей, перш ніж увімкнути платні операції для клієнтів.






