API documentation
Seznam Domény
Získat seznam uživatelových domén, podpora stránkování, třídění a filtrování podle stavu
Content-Type
application-json
kategorie
domain
akce
domain_list
Parametry žádosti
| Název parametru | Typ | Popis | Příklad |
|---|---|---|---|
| sort | Řetězec (volitelné) | Metoda řazení: name_asc (vzestupně podle domény), name_desc (sestupně podle domény), time_asc (vzestupně podle data registrace), time_desc (sestupně podle data registrace, výchozí) | time_desc |
| page_size | Celé číslo (volitelné) | Počet položek na stránku (výchozí: 10, podporováno: 10, 20, 30, 50, 100) | 20 |
| page_index | Celé číslo (volitelné) | Číslo stránky (výchozí: 1) | 1 |
| status | Řetězec (volitelné) | Stav domény: all (všechny domény, výchozí), active (aktivní domény), expired (expirované domény), stop (zastavené domény) | active |
| hold | Řetězec (volitelné) | Stav zadržení domény: prázdný řetězec (bez filtrování, výchozí), 0 (stav bez zadržení), 1 (stav zadržení) | 0 |
Parametry odpovědi
| Název parametru | Typ | Popis |
|---|---|---|
| code | Celé číslo | Stavový kód (200 znamená úspěch) |
| msg | Řetězec | Zpráva |
| data | Objekt | Datový objekt obsahující seznam domén a možnosti |
| data.options | Objekt | Možnosti dotazu včetně řazení, stránkování a filtrování |
| data.options.sort | Řetězec | Způsob řazení použitý v dotazu |
| data.options.page_size | Celé číslo | Počet položek na stránku |
| data.options.page_index | Celé číslo | Aktuální číslo stránky |
| data.options.status | Řetězec | Filtrovaný stav v dotazu |
| data.options.total | Celé číslo | Celkový počet záznamů |
| data.options.total_pages | Celé číslo | Celkový počet stránek |
| data.domain_list | Pole | Pole doménových objektů |
| data.domain_list.domain | Řetězec | Doménové jméno |
| data.domain_list.created_date | Datum | Datum vytvoření (RRRR-MM-DD) |
| data.domain_list.expired_date | Datum | Datum vypršení platnosti (RRRR-MM-DD) |
| data.domain_list.status | Řetězec | Stav domény (aktivní/expirující/pozastavená) |
| data.domain_list.nameservers | Pole | Pole DNS serverů |
| data.domain_list.hold | Celé číslo | Stav zablokování (0=neblokováno, 1=blokováno) |
Ukázka požadavku
{
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"
}
Vrácený výsledek
0 OK
Úspěšná odpověď
{
"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 Neplatný požadavek
{
"code": 400,
"msg" : "Request parameter error",
}
