API documentation
Zoznam Domény
Získajte zoznam používateľských domén, podporuje stránkovanie, zoradenie a filtrovanie podľa stavu
Content-Type
application-json
kategória
domain
akcia
domain_list
Parametre požiadavky
| Názov parametra | Typ | Popis | Príklad |
|---|---|---|---|
| sort | Reťazec (voliteľné) | Spôsob triedenia: name_asc (vzostupne podľa doménového mena), name_desc (zostupne podľa doménového mena), time_asc (vzostupne podľa času registrácie), time_desc (zostupne podľa času registrácie, predvolené) | time_desc |
| page_size | Celé číslo (voliteľné) | Počet položiek na stránku (predvolené: 10, podporované: 10, 20, 30, 50, 100) | 20 |
| page_index | Celé číslo (voliteľné) | Číslo stránky (predvolené: 1) | 1 |
| status | Reťazec (voliteľné) | Stav domény: všetky (všetky domény, predvolené), aktívne (aktívne domény), expirované (expirované domény), zastavené (zastavené domény) | active |
| hold | Reťazec (voliteľné) | Stav držania domény: prázdny reťazec (bez filtrovania, predvolené), 0 (nedržané), 1 (držané) | 0 |
Parametre odpovede
| Názov parametra | Typ | Popis |
|---|---|---|
| code | Celé číslo | Stavový kód (200 znamená úspech) |
| msg | Reťazec | Správa |
| data | Objekt | Dátový objekt obsahujúci zoznam domén a možnosti |
| data.options | Objekt | Možnosti vyhľadávania vrátane zoradenia, stránkovania a filtrov |
| data.options.sort | Reťazec | Metóda zoradenia použitá vo vyhľadávaní |
| data.options.page_size | Celé číslo | Počet položiek na stránku |
| data.options.page_index | Celé číslo | Aktuálne číslo stránky |
| data.options.status | Reťazec | Použitý filter stavu vo vyhľadávaní |
| data.options.total | Celé číslo | Celkový počet záznamov |
| data.options.total_pages | Celé číslo | Celkový počet strán |
| data.domain_list | Pole | Polia objektov domén |
| data.domain_list.domain | Reťazec | Doménové meno |
| data.domain_list.created_date | Dátum | Dátum vytvorenia (RRRR-MM-DD) |
| data.domain_list.expired_date | Dátum | Dátum vypršania platnosti (RRRR-MM-DD) |
| data.domain_list.status | Reťazec | Stav domény (aktívna/expirovaná/zastavená) |
| data.domain_list.nameservers | Pole | Zoznam DNS serverov |
| data.domain_list.hold | Celé číslo | Stav zablokovania (0=nie je zablokovaná, 1=zablokovaná) |
Príklad požiadavky
{
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"
}
Výsledok odpovede
0 OK
Úspešná odpoveď
{
"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 Zlá požiadavka
{
"code": 400,
"msg" : "Request parameter error",
}
