Dokumentacja NiceNIC Domain API v2 i szybki start
NiceNIC Domain API v2 jest dostępne zarówno dla kont Market, jak i kont Reseller. Skorzystaj z tego przeglądu, aby skonfigurować dostęp, potwierdzić pierwsze żądanie, zrozumieć model odpowiedzi API i przejść bezpośrednio do właściwej sekcji w nawigacji po lewej stronie.
Konto Market: dostęp do API z cenami dla kont Market.
Konto Reseller: dostęp do API z cenami przypisanymi do bieżącego poziomu resellera.
Porównaj poziomy i ceny resellerskie →
Przetestuj swoją integrację przed wdrożeniem produkcyjnym
Użyj API Piaskownica NiceNIC, aby przetestować integrację API dla domen przed przejściem do produkcji. Zweryfikuj uwierzytelnianie, żądania API, obsługę odpowiedzi oraz przepływ pracy aplikacji w dedykowanym środowisku testowym.
Idealny dla resellerów, dostawców hostingu, programistów i platform przygotowujących integrację API.
Wykonaj pierwsze wywołanie API w 4 krokach
Zacznij od żądania tylko do odczytu, zanim włączysz rejestracje, odnowienia lub transfery na żywo. Pozwoli Ci to zweryfikować uwierzytelnianie, formatowanie żądań i obsługę odpowiedzi bez składania płatnego zamówienia.
Włącz dostęp API
Otwórz ustawienia API, utwórz lub pobierz swój klucz tajny API i skonfiguruj autoryzowane adresy IP serwerów, jeśli ma to zastosowanie.
Potwierdź uwierzytelnienie
Użyj protokołu HTTPS z nagłówkiem Authorization w formacie username:api_secret.
Przeprowadź bezpieczny test
Zacznij od sprawdzenia dostępności domeny, cen, salda konta lub listy domen.
Obsługa odpowiedzi
Przeczytaj i zapisz zwrócone code i msg przed włączeniem płatnych działań produkcyjnych.
Zalecane pierwsze żądanie: dostępność domeny
Endpoint dostępności obsługuje wiele domen w jednym żądaniu — wystarczy oddzielić nazwy domen przecinkami.
Wybierz odpowiedni przepływ pracy
Poniższy przegląd odpowiada nawigacji po lewej stronie. Użyj go, aby zidentyfikować właściwy przepływ pracy, a następnie otwórz dedykowaną stronę punktu końcowego, aby zobaczyć parametry, przykłady żądań i przykłady odpowiedzi.
| Sekcja | Zastosowanie | Udokumentowane funkcje |
|---|---|---|
| Pierwsze kroki | Połącz się bezpiecznie i zrozum obsługę odpowiedzi. | Przegląd API, piaskownica API, uwierzytelnianie, kody odpowiedzi. |
| Zarządzanie domenami | Automatyzuj podstawowy cykl życia domeny. | Dostępność, lista domen, szczegóły domeny, rejestracja, odnowienie, transfer przychodzący, serwery nazw, kontakty, cennik. |
| Nadużycia i zgodność | Monitoruj domeny wymagające uwagi pod kątem zgodności. | Wyświetl listę domen z raportami nadużyć oraz pobierz odczytywalny maszynowo status nadużycia, cykl życia zawieszenia, informacje o skargach i zalecane działania. |
| Rekordy DNS | Zarządzaj rekordami DNS programistycznie. | Wyświetlaj, twórz, aktualizuj i usuwaj rekordy DNS. |
| Podrzędne serwery nazw | Zarządzaj rekordami host / glue dla serwerów nazw w ramach własnej domeny. | Twórz, wyświetlaj, aktualizuj i usuwaj autorytatywne serwery nazw. |
| Konto i rozliczenia | Podłącz automatyzację do kontroli na poziomie konta. | Saldo konta i informacje o transakcjach. |
| WHMCS API | Zintegruj NiceNIC z istniejącym przepływem rozliczeń WHMCS. | Dostępność, rejestracja, odnowienie, transfer, szczegóły domeny, serwery nazw, kontakty oraz dodatkowe funkcje modułu rejestratora. |
| Najczęstsze pytania dotyczące API | Rozwiązuj typowe pytania dotyczące dostępu, bezpieczeństwa, testowania i przepływu pracy. | Kwalifikowalność, poświadczenia, obsługa żądań, obsługiwane operacje i wskazówki dotyczące integracji. |
Zalecana pierwsza sekwencja integracji
Niezawodna integracja produkcyjna powinna zweryfikować warunki dostępu i zakupu, zanim zacznie wysyłać rzeczywiste zamówienia klientów.
API Secret + autoryzowane IP
Test łączności tylko do odczytu
Zapytanie o aktualny koszt na poziomie konta
Potwierdzenie środków na płatne operacje
Przetwarzanie kodu + wiadomości
Rejestracja / Odnowienie / Transfer
Zrozumienie odpowiedzi sukcesu, oczekujących i błędów
code: 0 — Odpowiedź sukcesu Przykłady punktów końcowych używają kodu 0 dla pomyślnie zakończonych odpowiedzi.
code: 201 — Zamówienie oczekujące Dokumentacja rejestracji i transferu może zwracać kod 201, gdy zamówienie zostało złożone, ale końcowe przetwarzanie jest nadal w toku.
code: 400 — Błąd żądania Przykłady punktów końcowych używają kodu 400 dla błędów parametrów żądania.
Zachowanie podczas oczekiwania na rejestrację
W przypadku rejestracji domeny aktualna dokumentacja wskazuje, że odpowiedź 201 oznacza, że zamówienie zostało pomyślnie przesłane, a opłata została pobrana, jednak ostateczna aktywacja nadal zależy od potwierdzenia rejestru. Jeśli domena nie może zostać aktywowana, opłata rejestracyjna zostanie zwrócona na saldo konta NiceNIC w ciągu 24 godzin.
Zachowanie transferu oczekującego
Endpoint transferu dokumentuje również 201 jako zamówienie oczekujące. Dlatego aplikacja powinna traktować transfer oczekujący jako przyjęty do przetworzenia, a nie jako dowód na to, że transfer został już ukończony.
Sprawdź ceny przed płatnymi operacjami
Endpoint cenowy NiceNIC umożliwia pobranie cen rejestracji, odnowienia i transferu domeny. Udokumentowane wartości type to register, renew, transfer oraz all. Udokumentowany okres wynosi od 1 do 10 lat, z możliwymi wyjątkami dla konkretnych TLD.
Odpowiedzi na zapytania o ceny rejestracji mogą również zwracać flagę is_premium. Użyj endpointu cenowego przed wysłaniem płatnego zapytania, gdy Twoja aplikacja musi znać bieżący koszt na poziomie konta.
Poznaj różnicę między serwerami nazw, rekordami DNS i serwerami nazw podrzędnymi
| Operacja | Kiedy użyć | Udokumentowana funkcjonalność |
|---|---|---|
| Aktualizuj serwery nazw | Chcesz delegować domenę do różnych autorytatywnych serwerów nazw. | Endpoint domeny dla serwerów nazw obsługuje główny, pomocniczy oraz dodatkowe serwery nazw, a niniejsza strona dokumentuje limit do sześciu. |
| Rekordy DNS | Korzystasz z hostingu DNS NiceNIC i musisz zarządzać rekordami strefy. | Dla listowania, tworzenia, aktualizowania i usuwania rekordów DNS udokumentowano osobne API. |
| Podrzędne serwery nazw | Musisz mieć rekordy hosta / glue, takie jak ns1.example.com. |
Twórz, wyświetlaj, aktualizuj i usuwaj podrzędne serwery nazw. Endpoint tworzenia wymaga, aby nazwa hosta serwera nazw odpowiadała domenie i akceptuje adres IP. |
Automatyzuj monitorowanie portfolio, nie tylko zamówienia domen
Domain API v2 obejmuje również operacje odczytu przydatne po rejestracji. Endpoint List Domains obsługuje paginację, sortowanie, filtrowanie według statusu i stanu wstrzymania, a Get Domain Details zwraca daty rejestracji, daty wygaśnięcia, serwery nazw oraz dane kontaktowe rejestrującego.
Monitorowanie nadużyć i zgodności
API nadużyć i zgodności NiceNIC może wyświetlić listę domen z raportami o nadużyciach i zwrócić szczegółowe, maszynowo czytelne podsumowanie dla konkretnej domeny. Szczegółowy punkt końcowy nadużyć dokumentuje sześć statusów na poziomie domeny: Normal, Under Review, Pending ClientHold, ClientHold, Closed i ServerHold.
Odpowiedź może zawierać bieżący wpływ, zalecane następne działanie, stan wstrzymania i oś czasu, liczbę skarg, daty skarg, kategorie, klasyfikację nadużyć DNS, status dowodów i zgłoszone adresy URL tam, gdzie ma to zastosowanie. Dzięki temu platformy i resellerzy mogą prezentować status zgodności w swoich własnych systemach operacyjnych, zamiast polegać wyłącznie na ręcznej weryfikacji.
Wybierz model integracji dopasowany do Twojego systemu
| Opcja | Przeznaczenie | Co zawiera obecna dokumentacja |
|---|---|---|
| Domain API v2 | Niestandardowe strony internetowe, platformy SaaS, systemy wewnętrzne, niestandardowe rozliczenia lub przepływy provisioningowe. | Bezpośrednia integracja HTTPS + JSON obejmująca operacje na domenach, DNS, dziecięcych serwerach nazw, kontach i zgodności. |
| Moduł WHMCS | Firmy hostingowe i resellerzy, którzy już korzystają z WHMCS. | Dostępność, rejestracja, odnowienie, transfer, szczegóły domeny, serwery nazw, kontakty, blokada/odblokowanie, pobieranie EPP, rejestrowanie błędów i opcjonalny tryb testowy. |
Obecna dokumentacja WHMCS wymienia jako wymagania: WHMCS 7.0 lub nowszy, PHP 7.0 lub nowszy z cURL, ważne poświadczenia API NiceNIC oraz obsługę SSL/TLS.
Gdy żądanie API nie powiedzie się
Zacznij od zwróconej odpowiedzi i stanu konfiguracji, zamiast wielokrotnie ponawiać tę samą płatną operację.
Błąd uwierzytelniania lub dostępu
- Potwierdź nazwę użytkownika NiceNIC i klucz API Secret.
- Potwierdź, że nagłówek Authorization jest obecny i poprawnie sformatowany.
- Potwierdź, że klucz API Secret nie został zresetowany ani zmieniony.
- Jeśli ograniczenia IP są włączone, potwierdź, że żądanie pochodzi z autoryzowanego adresu IP serwera wychodzącego.
Błąd parametru żądania
- Porównaj żądanie z udokumentowanymi parametrami danego punktu końcowego.
- Potwierdź wymagane wartości, formaty i nazwy akcji.
- Sprawdź okresy rejestracji specyficzne dla TLD lub wymagania dotyczące kontaktu, jeśli mają zastosowanie.
Płatna operacja nie kończy się natychmiast
- Przeczytaj zwrócone
codeimsg. - Nie traktuj odpowiedzi
201jako ostatecznego zakończenia. - Przed ponowieniem płatnej czynności potwierdź saldo konta i aktualne ceny.
Potrzebujesz wsparcia NiceNIC?
- Zanotuj znacznik czasu żądania i akcję API.
- Jeśli dotyczy, podaj nazwę domeny lub obiekt.
- Podaj zwrócony kod i komunikat.
- Udostępniaj tylko niewrażliwe parametry; nigdy nie podawaj pełnego klucza API Secret w zgłoszeniu.
Zacznij od bezpiecznego żądania testowego
Włącz dostęp do API, potwierdź uwierzytelnianie, wykonaj żądanie sprawdzenia dostępności lub ceny i zweryfikuj obsługę odpowiedzi przed włączeniem płatnych operacji skierowanych do klientów.






