API documentation
Lista Domeny
Pobierz listę domen użytkownika, obsługa paginacji, sortowania i filtrowania po statusie
Content-Type
application-json
kategoria
domain
akcja
domain_list
Parametry żądania
| Nazwa parametru | Typ | Opis | Przykład |
|---|---|---|---|
| sort | Tekst (opcjonalnie) | Metoda sortowania: name_asc (rosnąco według nazwy domeny), name_desc (malejąco według nazwy domeny), time_asc (rosnąco według daty rejestracji), time_desc (malejąco według daty rejestracji, domyślnie) | time_desc |
| page_size | Liczba całkowita (opcjonalnie) | Liczba pozycji na stronę (domyślnie: 10, dostępne: 10, 20, 30, 50, 100) | 20 |
| page_index | Liczba całkowita (opcjonalnie) | Numer strony (domyślnie: 1) | 1 |
| status | Tekst (opcjonalnie) | Status domeny: all (wszystkie domeny, domyślnie), active (aktywne domeny), expired (wygasłe domeny), stop (zatrzymane domeny) | active |
| hold | Tekst (opcjonalnie) | Status blokady domeny: pusty ciąg (brak filtrowania, domyślnie), 0 (brak blokady), 1 (blokada) | 0 |
Parametry odpowiedzi
| Nazwa parametru | Typ | Opis |
|---|---|---|
| code | Liczba całkowita | Kod statusu (200 oznacza sukces) |
| msg | Łańcuch znaków | Wiadomość |
| data | Obiekt | Obiekt danych zawierający listę domen i opcje |
| data.options | Obiekt | Opcje zapytania, w tym sposoby sortowania, paginację i filtrowanie |
| data.options.sort | Łańcuch znaków | Metoda sortowania używana w zapytaniu |
| data.options.page_size | Liczba całkowita | Liczba elementów na stronę |
| data.options.page_index | Liczba całkowita | Bieżący numer strony |
| data.options.status | Łańcuch znaków | Filtr statusu zastosowany do zapytania |
| data.options.total | Liczba całkowita | Łączna liczba rekordów |
| data.options.total_pages | Liczba całkowita | Łączna liczba stron |
| data.domain_list | Tablica | Tablica obiektów domen |
| data.domain_list.domain | Łańcuch znaków | Nazwa domeny |
| data.domain_list.created_date | Data | Data utworzenia (RRRR-MM-DD) |
| data.domain_list.expired_date | Data | Data wygaśnięcia (RRRR-MM-DD) |
| data.domain_list.status | Łańcuch znaków | Status domeny (aktywny/wygasły/zatrzymany) |
| data.domain_list.nameservers | Tablica | Tablica serwerów DNS |
| data.domain_list.hold | Liczba całkowita | Status blokady (0=niezablokowany, 1=zablokowany) |
Przykład zapytania
{
curl https://api.nicenic.net/v2/?category=domain&action=domain_list&sort={sort}&page_size={page_size}&page_index={page_index}&status={status}&hold={hold}
-H "Authorization: username:api_secret"
-H "Content-Type: application/json"
}
Zwrócony wynik
0 OK
Udana odpowiedź
{
"code": 0,
"msg" : "success",
"data" : {
"options": {
"sort": "time_desc",
"page_size": 20,
"page_index": 1,
"status": "active",
"total": 50,
"total_pages": 3
},
"domain_list": [
{
"domain": "example.com",
"created_date": "2023-01-15",
"expired_date": "2025-01-15",
"status": "active",
"nameservers": ["ns1.example.com", "ns2.example.com"],
"hold": 0
}
]
}
}
400 Nieprawidłowe żądanie
{
"code": 400,
"msg" : "Request parameter error",
}
