Поширені запитання щодо NiceNIC Domain API v2
Знайдіть практичні відповіді щодо доступу до API, тестування в Sandbox, автентифікації, ціноутворення, операцій із доменами, обробки відповідей та інтеграції у виробниче середовище.
Початок роботи
Почніть із доступу, ціноутворення та облікових даних.
01 Що таке NiceNIC Domain API v2?
NiceNIC Domain API v2 — це API на основі HTTPS та JSON для автоматизації керування доменами через ваш обліковий запис NiceNIC.
Він підтримує основні робочі процеси, зокрема перевірку доступності доменів, реєстрацію, продовження, передачу, запити портфеля, оновлення серверів імен та контактів, ціноутворення, записи DNS, дитячі сервери імен, інформацію про обліковий запис та операції, пов'язані з відповідністю.
Використовуйте API, коли потрібно підключити доменні послуги NiceNIC безпосередньо до веб-сайту, хостинг-платформи, білінгової системи, внутрішнього інструменту або іншого застосунку.
02 Хто може використовувати NiceNIC Domain API v2?
Будь-який активний обліковий запис NiceNIC може використовувати Domain API v2. Доступ до API доступний як для ринкових облікових записів, так і для облікових записів реселерів.
Вам не потрібно ставати реселером лише для отримання доступу до API. Тип облікового запису все ще впливає на ціноутворення: платні операції API використовують ціни, призначені для облікового запису NiceNIC, який надсилає запит.
03 Чи є NiceNIC Domain API v2 безкоштовним?
Так. Сам доступ до API безкоштовний. Окремої плати за ввімкнення доступу до API або надсилання підтримуваних API-запитів немає.
Платні операції, такі як реєстрація домену, продовження та передача, тарифікуються відповідно до цін вашого облікового запису та чинних правил для доменів.
04 Чи потрібен мені акаунт реселера для використання API?
Ні. Доступ до API та ціни для реселерів — це окремі речі.
Ви можете використовувати Domain API v2 зі звичайним ринковим акаунтом NiceNIC. Переходьте на акаунт реселера лише тоді, коли ціни для реселерів або інші переваги реселерів будуть корисні для вашого обсягу бізнесу.
05 Чим API v2 відрізняється від старішого API NiceNIC?
Domain API v2 використовує поточну структуру API NiceNIC із запитами HTTPS, відповідями JSON, автентифікацією на основі заголовків і документацією, організованою навколо окремих робочих процесів для доменів та облікових записів.
Якщо ви підтримуєте інтеграцію, створену на основі старішого API NiceNIC, перегляньте параметри API v2 та обробку відповідей перед перенесенням робочого трафіку, не припускаючи, що дві версії взаємозамінні.
06 Як отримати облікові дані API?
Увійдіть у свій обліковий запис NiceNIC і відкрийте Налаштування API. Запити API v2 використовують ваше ім’я користувача NiceNIC та секретний ключ API для автентифікації.
Пісочниця та автентифікація
Підключайтеся безпечно та тестуйте перед переходом у продакшн.
07 Чи надає NiceNIC Domain API v2 тестове середовище API?
Так. NiceNIC надає тестове середовище API для розробників, щоб тестувати інтеграції перед підключенням до продакшн API.
Використовуйте тестове середовище, щоб перевірити автентифікацію, форматування запитів, розбір відповідей, обробку помилок і робочий процес вашого застосунку перед увімкненням реальних операцій з доменами клієнтів.
08 Яка різниця між тестовим середовищем і продакшн API?
Тестове середовище API призначене для розробки та тестування інтеграцій. Продакшн API використовується для реальних операцій з доменами та платних запитів до вашого облікового запису NiceNIC.
Ми рекомендуємо перевіряти автентифікацію, обробку запитів, обробку відповідей і логіку помилок у тестовому середовищі перед увімкненням операцій продакшну, орієнтованих на клієнтів.
09 Як працює автентифікація API?
Надсилайте API-запити через HTTPS і вказуйте ваше ім'я користувача NiceNIC та секрет API у заголовку Authorization.
Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/jsonЯкщо для вашого облікового запису ввімкнено обмеження за IP-адресою, запити також мають надходити з авторизованої серверної IP-адреси.
10 Яку кінцеву точку використовує Domain API v2?
Базова кінцева точка Production API:
https://api.nicenic.net/v2/Дії API вибираються за допомогою параметрів, задокументованих для кожної кінцевої точки, наприклад category та action. Завжди дотримуйтесь документації конкретної кінцевої точки щодо обов’язкових і необов’язкових параметрів для певної операції.
11 Який формат відповіді та кодування символів використовує API v2?
Відповіді API v2 використовують JSON, а параметри запитів — UTF-8.
{
"code": 0,
"msg": "success",
"data": {}
}Ваш застосунок має перевіряти отримані code та msg, а не припускати, що кожна HTTP-відповідь означає успішно виконану операцію з доменом.
Операції з доменами та ціни
Дізнайтеся про підтримувані робочі процеси та поведінку під час купівлі.
12 Що я можу робити за допомогою NiceNIC Domain API v2?
Завдяки задокументованим API ви можете автоматизувати робочі процеси, зокрема перевірку доступності доменів, реєстрацію, продовження та трансфер, перелік портфоліо та деталі доменів, оновлення серверів імен і контактних даних домену, ціноутворення на домени, DNS-записи, дитячі сервери імен, інформацію про акаунт, а також моніторинг зловживань і відповідності (Abuse & Compliance).
Інші робочі процеси задокументовані окремо в навігації API.
13 Що слід протестувати перед увімкненням реальної реєстрації або трансферів?
Почніть із низькоризикових операцій читання, таких як перевірка доступності домену, ціноутворення, баланс акаунта та перелік доменів.
Потім переконайтеся в коректності автентифікації, обробки відповідей, обробки помилок і роботи з відкладеними замовленнями перед увімкненням реальної реєстрації, продовження або трансферу.
14 Чи можу я перевірити кілька доменів в одному API-запиті?
Так. Точка доступу Check Domain Availability підтримує кілька доменних імен, розділених комами.
example.com,example.net,example.orgНе припускайте, що кожна операція API підтримує той самий формат введення кількох доменів. Реєстрація, продовження та трансфер мають виконуватися згідно з документацією відповідної точки доступу.
15 Як я можу дізнатися ціни на реєстрацію, продовження та трансфер?
Використовуйте кінцеву точку Get Domain Pricing. Документовані типи цін включають register, renew, transfer та all.
Відповіді на запити реєстрації також можуть містити значення is_premium, яке вказує, чи є запитана реєстрація преміальною.
Оскільки замовлення через API використовують ціни на рівні облікового запису, перевіряйте актуальні ціни перед поданням платних замовлень клієнтів, а не покладайтеся надовго на кешовані ціни.
16 Чи можна зареєструвати або продовжити кожен TLD на 1–10 років?
Ні. Хоча документація API підтримує періоди до 1–10 років для відповідних розширень, окремі TLD можуть мати різні правила реєстру.
Періоди реєстрації, періоди продовження, право на передачу, вимоги до контактних даних і вимоги до верифікації можуть відрізнятися залежно від розширення. Ваш застосунок має дотримуватися чинних правил для відповідного TLD.
17 У чому різниця між серверами імен, DNS-записами та дочірніми серверами імен?
ns1.example.com.Це окремі операції, і їх не слід вважати взаємозамінними.
Відповіді та помилки
Правильно обробляйте успішні стани, стани очікування та помилки.
18 Що означають коди відповідей API?
| Код | Значення |
|---|---|
0 | Успіх |
201 | Очікує |
400 | Помилка параметра |
401 | Не авторизовано |
404 | Відповідних записів не знайдено |
500 | Внутрішня помилка сервера |
Під час визначення стану API-запиту завжди використовуйте повернутий код і повідомлення.
19 Що означає код 201?
Відповідь 201 означає, що операцію прийнято до обробки, але її кінцевий стан ще не обов'язково досягнуто.
20 Що відбувається, коли реєстрація домену повертає код 201?
Для реєстрації домену відповідь 201 означає, що замовлення надіслано та очікує на остаточну обробку в реєстрі.
Не повідомляйте кінцевому клієнту, що домен активний, доки ваша система не підтвердить остаточний результат. Дотримуйтесь документації кінцевої точки реєстрації щодо актуальних правил обробки очікуваних замовлень і повернень коштів.
21 Що означає відповідь про очікування передачі (Pending transfer)?
Очікування передачі означає, що запит на передачу прийнято до обробки, а не те, що домен уже завершив передачу до NiceNIC.
Завершення передачі може залежати від обробки в реєстрі та реєстратора, а також від поточного статусу передачі домену. Зберігайте статус передачі як очікуваний, доки не буде підтверджено її завершення.
Портфелі, комплаєнс та інтеграція
Керуйте портфелями та підключайте наявні системи.
22 Чи можу я отримувати та фільтрувати свій портфель доменів через API?
Так. API List Domains підтримує отримання портфеля з параметрами пагінації, сортування та фільтрації.
Використовуйте Get Domain Details, коли потрібна детальна інформація про окремий домен, наприклад, дані про реєстрацію, термін дії, сервери імен та контактні дані домену.
23 Що може робити API для боротьби зі зловживаннями та комплаєнсу?
NiceNIC Domain API v2 включає операції щодо зловживань та комплаєнсу, призначені для платформ і реселерів, які керують портфелями доменів своїх клієнтів.
Ви можете визначити домени, пов'язані зі скаргами про зловживання, та отримати машиночитанну інформацію про відповідність для окремих доменів. Залежно від випадку, відповідь може містити статус домену, поточний вплив, рекомендовані дії, інформацію про блокування, дані про скарги та повідомлені URL-адреси.
Це дозволяє відображати статус відповідності безпосередньо у вашому клієнтському порталі або операційній системі.
24 Чи можу я використовувати NiceNIC Domain API v2 з WHMCS?
Так. NiceNIC надає інтеграцію реєстратора з WHMCS для компаній, які вже використовують WHMCS для білінгу та надання послуг.
Використовуйте прямий Domain API v2, якщо ви створюєте власний застосунок або робочий процес. Використовуйте інтеграцію з WHMCS, якщо вам потрібно інтегрувати операції з доменами в наявне середовище WHMCS.
Розробка та підтримка
Безпечно розробляйте та знайте, що надсилати, коли вам потрібна допомога.
25 Які мови програмування я можу використовувати?
Будь-яка серверна мова програмування або середовище виконання, здатне надсилати HTTPS-запити та обробляти JSON, може інтегруватися з Domain API v2.
Зазвичай обирають PHP, Python, Node.js та Java. Зберігайте облікові дані API на сервері та ніколи не розкривайте ваш API Secret у JavaScript на боці браузера або в завантажуваному клієнтському коді.
26 Чи існують обмеження частоти запитів до API?
Обмеження частоти запитів може застосовуватися для захисту стабільності API та безпеки платформи.
Якщо ваша виробнича інтеграція, як очікується, буде створювати стабільно високий обсяг запитів, зв'яжіться з NiceNIC перед запуском, щоб ваш очікуваний шаблон використання було перевірено.
27 Що слід зазначити, звертаючись до підтримки з проблемою API?
Вкажіть часову мітку запиту, категорію та дію API, назву домену, якщо застосовно, неконфіденційні параметри запиту, отриманий код відповіді та повідомлення, а також чи запит надійшов із Sandbox або Production.
28 Де я можу знайти повні параметри запиту та приклади коду?
Скористайтеся навігацією по API в документації. Кожна операція має власну сторінку з підтримуваними параметрами, прикладами запитів, прикладами відповідей та специфічною поведінкою операції.
FAQ пояснює загальну поведінку API; документація по окремих кінцевих точках має вважатися джерелом істини щодо точного формату запиту.
Готові почати створення?
Перевірте свою інтеграцію в тестовому середовищі API, а потім підключіть свій обліковий запис NiceNIC, коли будете готові до переходу у виробниче середовище.
Потрібні ціни для реселерів за більший обсяг доменів?
Порівняти плани для реселерів →
