Често задавани въпроси за NiceNIC Domain API v2

NiceNIC Domain API v2 е API, базиран на HTTPS и JSON, за автоматизиране на управлението на домейни чрез вашия акаунт в NiceNIC.

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

Използвайте API, когато искате да свържете услугите за домейни на NiceNIC директно към уебсайт, хостинг платформа, система за фактуриране, вътрешен инструмент или друго приложение.

Всеки активен акаунт в NiceNIC може да използва Domain API v2. Достъпът до API е наличен както за пазарни акаунти, така и за акаунти за резелери.

Не е необходимо да ставате резейлър само за да получите достъп до API. Видът на акаунта все пак има значение за цените: платените API операции използват цените, зададени за акаунта в NiceNIC, който изпраща заявката.

Отворете настройките на API →

Да. Самият API достъп е безплатен. Няма отделна такса за активиране на API достъп или за изпращане на поддържани API заявки.

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

Не. API достъпът и цените за търговци на дребно са отделни.

Можете да използвате Domain API v2 с обикновен NiceNIC Market Account. Надстройте до акаунт за търговец на дребно само ако цените за търговци на дребно или други предимства за търговци са полезни за обема на вашия бизнес.

Сравнете плановете за търговци на дребно →

Domain API v2 използва текущата структура на NiceNIC API с HTTPS заявки, JSON отговори, удостоверяване на базата на заглавки и документация, организирана около отделни работни процеси за домейни и акаунти.

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

Влезте във вашия NiceNIC акаунт и отворете API Settings. Заявките на API v2 използват вашето NiceNIC потребителско име и API Secret за удостоверяване.

Отворете настройките на 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 удостоверяване →

Основната крайна точка на Production API е:

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

API действията се избират чрез параметрите, документирани за всяка крайна точка, като например category и action. Винаги следвайте документацията за съответната крайна точка за задължителните и незадължителните параметри на конкретна операция.

API v2 отговорите използват JSON, а параметрите на заявките използват UTF-8.

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

Вашето приложение трябва да проверява върнатите code и msg, вместо да приема, че всеки HTTP отговор представлява завършена домейн операция.

Чрез документираните в момента API можете да автоматизирате работни процеси, включващи проверки за наличност на домейни, регистрация, подновяване и трансфер, списък на портфолиото и данни за домейни, актуализации на сървъри за имена и контакти на домейни, ценообразуване на домейни, DNS записи, дъщерни сървъри за имена, информация за акаунта и наблюдение на злоупотреби и съответствие (Abuse & Compliance).

Допълнителни работни процеси са документирани поотделно в навигацията на API.

Започнете с операции с нисък риск за четене, като проверка за наличност на домейни, ценообразуване на домейни, баланс на акаунта и списък на домейни.

След това потвърдете удостоверяването, анализа на отговорите, обработката на грешки и обработката на чакащи поръчки, преди да активирате реални регистрации, подновявания или трансфери.

Да. Крайната точка Check Domain Availability поддържа множество имена на домейни, разделени със запетаи.

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 показва, че поръчката е подадена и очаква окончателна обработка от регистъра.

Не казвайте на краен клиент, че домейнът е активен, докато вашата система не потвърди крайния резултат. Следвайте документацията за крайната точка на регистрация за актуалните правила относно чакащи поръчки и възстановявания.

Чакащ трансфер означава, че заявката за трансфер е приета за обработка, а не че домейнът вече е завършил трансфера си към NiceNIC.

Завършването на трансфера може да зависи от обработката от страна на регистъра и регистратора, както и от текущия статус на трансфера на домейна. Запазете трансфера в чакащо състояние, докато не бъде потвърдено завършването.

Да. API List Domains поддържа извличане на портфолио с опции за пагинация, сортиране и филтриране.

Използвайте Get Domain Details, когато имате нужда от подробна информация за отделен домейн, като данни за регистрация, данни за изтичане, nameservers и данни за контакт на домейна.

NiceNIC Domain API v2 включва операции за злоупотреби и съответствие, предназначени за платформи и resellers, управляващи клиентски домейн портфолиа.

Можете да идентифицирате домейни, свързани с доклади за злоупотреби, и да извличате машинночетима информация за съответствие за отделни домейни. В зависимост от случая отговорът може да включва статус на домейна, текущо въздействие, препоръчано действие, информация за задържане, информация за жалби и докладвани URL адреси.

Това позволява статусът на съответствие да се показва директно във вашия собствен клиентски портал или операционна система.

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

Използвайте директния Domain API v2, когато изграждате свое собствено приложение или работен процес. Използвайте интеграцията с WHMCS, когато искате домейн операциите да бъдат интегрирани в съществуваща WHMCS среда.

Вижте интеграцията с WHMCS →

Всеки сървърен език за програмиране или среда за изпълнение, която може да изпраща HTTPS заявки и да анализира JSON, може да се интегрира с Domain API v2.

Обичайни избори включват PHP, Python, Node.js и Java. Съхранявайте API идентификационните данни от сървърна страна и никога не разкривайте API тайната си в JavaScript от страна на браузъра или в изтегляем клиентски код.

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

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

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

Изпратете заявка →

Използвайте навигацията в API документацията. Всяка операция има собствена страница за поддържаните параметри, примери за заявки, примери за отговори и специфичното поведение за операцията.

Често задаваните въпроси обясняват общото поведение на API; документацията за отделните крайни точки трябва да се счита за източник на истина за точния формат на заявката.

Отваряне на документацията на API →