NiceNIC Domain API v2 — najczęściej zadawane pytania

NiceNIC Domain API v2 to interfejs API oparty na HTTPS i JSON, służący do automatyzacji zarządzania domenami za pośrednictwem Twojego konta NiceNIC.

Obsługuje podstawowe procesy, w tym sprawdzanie dostępności domen, rejestrację, odnawianie, transfery, zapytania o portfel, aktualizacje serwerów nazw i danych kontaktowych, cenniki, rekordy DNS, dziecięce serwery nazw, informacje o koncie oraz operacje związane z compliance.

Użyj interfejsu API, gdy chcesz podłączyć usługi domenowe NiceNIC bezpośrednio do strony internetowej, platformy hostingowej, systemu rozliczeniowego, narzędzia wewnętrznego lub innej aplikacji.

Każde aktywne konto NiceNIC może korzystać z Domain API v2. Dostęp do API jest dostępny zarówno dla kont Market, jak i kont Reseller.

Nie musisz zostać resellerem, aby uzyskać dostęp do API. Typ konta nadal ma znaczenie dla cen: płatne operacje API korzystają z cennika przypisanego do konta NiceNIC wysyłającego żądanie.

Otwórz Ustawienia API →

Tak. Sam dostęp do API jest bezpłatny. Nie ma osobnej opłaty za włączenie dostępu do API ani za wysyłanie obsługiwanych żądań API.

Operacje płatne, takie jak rejestracja domeny, odnowienie i transfer, są naliczane zgodnie z cennikiem Twojego konta oraz obowiązującymi zasadami dotyczącymi domen.

Nie. Dostęp do API i ceny resellerskie są rozdzielne.

Możesz korzystać z Domain API v2 przy zwykłym koncie NiceNIC Market. Przejdź na konto resellerskie dopiero wtedy, gdy ceny resellerskie lub inne korzyści dla resellerów będą przydatne przy Twoim wolumenie działalności.

Porównaj plany resellerskie →

Domain API v2 wykorzystuje obecną strukturę API NiceNIC z żądaniami HTTPS, odpowiedziami JSON, uwierzytelnianiem opartym na nagłówkach oraz dokumentacją zorganizowaną wokół poszczególnych przepływów pracy związanych z domenami i kontami.

Jeśli utrzymujesz integrację opartą na starszym API NiceNIC, przed migracją ruchu produkcyjnego przejrzyj parametry API v2 i obsługę odpowiedzi, zamiast zakładać, że obie wersje są wymienne.

Zaloguj się do swojego konta NiceNIC i otwórz API Settings. Żądania API v2 wykorzystują Twoją nazwę użytkownika NiceNIC oraz API Secret do uwierzytelniania.

Otwórz Ustawienia API →

Tak. NiceNIC udostępnia piaskownicę API, aby programiści mogli testować integracje przed podłączeniem ich do produkcyjnego API.

Użyj piaskownicy do weryfikacji uwierzytelniania, formatowania żądań, parsowania odpowiedzi, obsługi błędów i przepływu pracy aplikacji przed włączeniem operacji na domenach klientów w środowisku produkcyjnym.

Otwórz piaskownicę API →

Piaskownica API jest przeznaczona do testowania rozwoju i integracji. Produkcyjne API służy do rzeczywistych operacji na domenach i płatnych żądań na koncie NiceNIC.

Zalecamy weryfikację uwierzytelniania, obsługi żądań, przetwarzania odpowiedzi i logiki błędów w piaskownicy przed włączeniem operacji produkcyjnych skierowanych do klientów.

Wysyłaj żądania API przez HTTPS i umieść swoją nazwę użytkownika NiceNIC oraz klucz tajny API w nagłówku Authorization.

Host: api.nicenic.net
Authorization: username:api_secret
Content-Type: application/json

Jeśli dla Twojego konta włączone są ograniczenia IP, żądania muszą pochodzić z autoryzowanego adresu IP serwera.

Przeczytaj o uwierzytelnianiu API →

Podstawowy punkt końcowy produkcyjnego API to:

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

Akcje API wybiera się za pomocą parametrów udokumentowanych dla każdego punktu końcowego, takich jak category i action. Zawsze postępuj zgodnie z dedykowaną dokumentacją punktu końcowego, aby poznać wymagane i opcjonalne parametry konkretnej operacji.

Odpowiedzi API v2 używają formatu JSON, a parametry żądań – kodowania UTF-8.

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

Twoja aplikacja powinna sprawdzać zwracane code i msg, zamiast zakładać, że każda odpowiedź HTTP oznacza zakończoną operację domenową.

Dzięki obecnie udokumentowanym API możesz automatyzować procesy, w tym sprawdzanie dostępności domen, rejestrację, odnawianie i transfer, listę portfolio oraz szczegóły domen, aktualizacje serwerów nazw i kontaktów domen, cennik domen, rekordy DNS, autorytatywne serwery nazw, informacje o koncie oraz monitoring nadużyć i zgodności.

Dodatkowe procesy są udokumentowane osobno w nawigacji API.

Zacznij od operacji odczytu niskiego ryzyka, takich jak sprawdzanie dostępności domen, cennik domen, saldo konta i lista domen.

Następnie potwierdź uwierzytelnianie, parsowanie odpowiedzi, obsługę błędów i obsługę oczekujących zamówień przed włączeniem rejestracji, odnowień lub transferów na żywo.

Tak. Endpoint Check Domain Availability obsługuje wiele nazw domen oddzielonych przecinkami.

example.com,example.net,example.org

Nie zakładaj, że każda operacja API obsługuje ten sam format wprowadzania wielu domen. Rejestracja, odnowienie i transfer powinny być zgodne z indywidualną dokumentacją endpointu.

Użyj punktu końcowego Get Domain Pricing. Udokumentowane typy cen obejmują register, renew, transfer oraz all.

Odpowiedzi dotyczące rejestracji mogą również zawierać wartość is_premium wskazującą, czy sprawdzana rejestracja jest premium.

Ponieważ zamówienia API korzystają z cen na poziomie konta, przed złożeniem płatnych zamówień klientów sprawdzaj aktualne ceny, zamiast polegać bezterminowo na zapisanych w pamięci podręcznej.

Nie. Chociaż dokumentacja API obsługuje okresy do 1–10 lat dla odpowiednich rozszerzeń, poszczególne TLD mogą mieć różne zasady rejestru.

Okresy rejestracji, okresy odnowienia, kwalifikowalność transferu, wymagania dotyczące kontaktu i weryfikacji mogą się różnić w zależności od rozszerzenia. Twoja aplikacja powinna przestrzegać aktualnych zasad dla danego TLD.

To osobne operacje i nie należy ich traktować jako wzajemnie wymiennych.

Przy określaniu stanu żądania API zawsze używaj zwróconego kodu i komunikatu.

Zobacz kody odpowiedzi API →

Odpowiedź 201 oznacza, że operacja została przyjęta do przetworzenia, ale niekoniecznie osiągnęła stan końcowy.

W przypadku rejestracji domeny odpowiedź 201 oznacza, że zamówienie zostało złożone i oczekuje na końcowe przetwarzanie w rejestrze.

Nie informuj klienta końcowego, że domena jest aktywna, dopóki Twój system nie potwierdzi końcowego wyniku. Postępuj zgodnie z dokumentacją punktu końcowego rejestracji, aby poznać aktualne zasady obsługi zamówień oczekujących i zwrotów.

Oczekujący transfer oznacza, że żądanie transferu zostało przyjęte do przetworzenia, ale nie oznacza, że domena została już przeniesiona do NiceNIC.

Zakończenie transferu może zależeć od przetwarzania w rejestrze i rejestratorze oraz od bieżącego statusu transferu domeny. Utrzymuj transfer w stanie oczekującym do czasu potwierdzenia zakończenia.

Tak. API List Domains obsługuje pobieranie portfolio z opcjami paginacji, sortowania i filtrowania.

Użyj Get Domain Details, gdy potrzebujesz szczegółowych informacji o pojedynczej domenie, takich jak dane rejestracyjne, dane wygaśnięcia, serwery nazw i dane kontaktowe domeny.

NiceNIC Domain API v2 obejmuje operacje Abuse & Compliance zaprojektowane dla platform i resellerów zarządzających portfelami domen klientów.

Możesz identyfikować domeny powiązane z raportami nadużyć i pobierać informacje o zgodności w formacie maszynowym dla poszczególnych domen. W zależności od przypadku odpowiedź może zawierać status domeny, bieżący wpływ, zalecane działanie, informacje o blokadzie, informacje o skardze i zgłoszone URL-e.

Dzięki temu możliwe jest wyświetlanie statusu zgodności bezpośrednio w Twoim własnym portalu klienta lub systemie operacyjnym.

Tak. NiceNIC zapewnia integrację rejestratora WHMCS dla firm, które już używają WHMCS do rozliczeń i udostępniania usług.

Użyj bezpośredniego interfejsu Domain API v2, gdy budujesz własną aplikację lub przepływ pracy. Skorzystaj z integracji WHMCS, gdy chcesz zintegrować operacje domenowe z istniejącym środowiskiem WHMCS.

Zobacz integrację WHMCS →

Każdy język programowania po stronie serwera lub środowisko uruchomieniowe, które potrafi wysyłać żądania HTTPS i analizować JSON, może zintegrować się z Domain API v2.

Typowe wybory to PHP, Python, Node.js i Java. Przechowuj dane uwierzytelniające API po stronie serwera i nigdy nie ujawniaj swojego API Secret w kodzie JavaScript działającym w przeglądarce ani w kodzie klienta do pobrania.

Limity żądań mogą być stosowane w celu ochrony stabilności API i bezpieczeństwa platformy.

Jeśli Twoja integracja produkcyjna ma generować stały wysoki wolumen żądań, skontaktuj się z NiceNIC przed uruchomieniem, aby można było przeanalizować przewidywany wzorzec użycia.

Podaj znacznik czasu żądania, kategorię i akcję API, nazwę domeny, jeśli ma zastosowanie, niejawne parametry żądania, zwrócony kod odpowiedzi i komunikat oraz informację, czy żądanie pochodziło ze środowiska Sandbox, czy z produkcji.

Wyślij zgłoszenie →

Skorzystaj z nawigacji API w dokumentacji. Każda operacja ma własną stronę z obsługiwanymi parametrami, przykładami żądań, przykładami odpowiedzi i szczegółowym opisem zachowania.

Ta sekcja pytań i odpowiedzi wyjaśnia ogólne zachowanie API; dokumentacja poszczególnych punktów końcowych powinna być traktowana jako źródło prawdy dotyczące dokładnego formatu żądań.

Otwórz dokumentację API →