Документация на NiceNIC Domain API v2 и бърз старт
NiceNIC Domain API v2 е достъпен както за пазарни акаунти, така и за акаунти на препродавачи. Използвайте този преглед, за да настроите достъпа, потвърдите първата си заявка, разберете модела на API отговора и преминете директно към съответния раздел в лявата навигация.
Market Account: API достъп с цени за Market Account.
Reseller Account: API достъп с цените, определени за текущото ниво на резилъра.
Сравнете нивата и цените за резилъри →
Тествайте интеграцията си, преди да я пуснете на живо
Използвайте тестовата среда на NiceNIC API, за да тествате интеграцията си с 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 тайна + упълномощен IP
Тест за свързаност само за четене
Проверка на текущата цена за акаунта
Потвърждение на средства за платени действия
Обработка на код + съобщение
Регистрация / Подновяване / Трансфер
Разбиране на отговорите за успех, чакане и грешка
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 и трябва да управлявате записите в зоната. | Документирани са отделни API за изброяване, създаване, актуализиране и изтриване на DNS записи. |
| Дъщерни именни сървъри | Имате нужда от host/glue записи като ns1.example.com. |
Създаване, изброяване, актуализиране и изтриване на дъщерни сървъри за имена. Endpoint-ът за създаване изисква hostname на сървъра за имена да съответства на домейна и приема IP адрес. |
Автоматизирайте мониторинга на портфолиото, не само поръчките за домейни.
Domain API v2 също включва операции за четене, които са полезни след регистрация. Endpoint-ът List Domains поддържа странициране, сортиране, филтриране по статус и филтриране по задържане, докато Get Domain Details връща дати на регистрация, дати на изтичане, сървъри за имена и информация за контакт с регистранта.
Мониторинг на злоупотреби и комплайънс
API за злоупотреби и комплайънс на NiceNIC може да изброява домейни с доклади за злоупотреби и да връща подробно обобщение в машинночетим формат за конкретен домейн. Подробният endpoint за злоупотреби документира шест статусни фрази на ниво домейн: Normal, Under Review, Pending ClientHold, ClientHold, Closed and ServerHold.
Отговорът може да включва текущо въздействие, препоръчано следващо действие, състояние на задържане и хронология, брой оплаквания, дати на оплаквания, категории, класификация на DNS злоупотреби, статус на доказателствата и докладвани URL адреси, когато е приложимо. Това позволява на платформите и резселърите да показват статуса на комплайънса в собствените си системи, вместо да разчитат само на ръчна проверка.
Изберете интеграционния модел, който подхожда на вашата система
| Опция | Подходящ за | Какво предоставя текущата документация |
|---|---|---|
| Domain API v2 | Персонализирани уебсайтове, SaaS платформи, вътрешни системи, персонализирани работни процеси за фактуриране или предоставяне на услуги. | Директна HTTPS + JSON интеграция за операции с домейни, DNS, дъщерни именови сървъри, акаунти и съответствие. |
| WHMCS модул | Хостинг компании и препродавачи, които вече използват WHMCS. | Наличност, регистрация, подновяване, трансфер, данни за домейна, именови сървъри, контакти, заключване/отключване, извличане на EPP, регистриране на грешки и опционален тестов режим. |
Текущата документация на WHMCS посочва като изисквания WHMCS 7.0 или по-нова версия, PHP 7.0 или по-нова версия с cURL, валидни идентификационни данни за NiceNIC API и поддръжка на SSL/TLS.
Когато API заявката не успее
Започнете с върнатия отговор и състоянието на конфигурацията, вместо да повтаряте многократно същото платено действие.
Грешка при удостоверяване или достъп
- Потвърдете потребителското име на NiceNIC и API тайната.
- Потвърдете, че заглавката за оторизация е налична и е правилно форматирана.
- Потвърдете, че API тайната не е нулирана или сменена.
- Ако са активирани IP ограничения, потвърдете, че заявката идва от оторизирания IP адрес на изходящия сървър.
Грешка в параметрите на заявката
- Сравнете заявката с документираните параметри на конкретната крайна точка.
- Потвърдете задължителните стойности, форматите и имената на действията.
- Проверете специфичните за TLD периоди на регистрация или изисквания за контакт, ако е приложимо.
Платената операция не се изпълнява незабавно
- Прочетете върнатите
codeиmsg. - Не третирайте изчакващ отговор с
201като окончателно завършване. - Потвърдете баланса на акаунта и актуалните цени, преди да опитате отново платено действие.
Нуждаете се от поддръжка на NiceNIC
- Запишете времевата отметка на заявката и API действието.
- Посочете името на домейна или съответния обект, когато е приложимо.
- Включете върнатия код и съобщение.
- Споделяйте само нечувствителни параметри; никога не публикувайте пълния API Secret в заявка.
Започнете с безопасна тестова заявка
Активирайте API достъпа, потвърдете удостоверяването, изпълнете заявка за наличност или цени и проверете обработката на отговорите, преди да включите платени операции, насочени към клиенти.






