API documentation
Zoznam Domény
Získajte zoznam pou?ívate?skych 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 | Stavovy kód (200 znamená úspech) |
| msg | Re?azec | Správa |
| data | Objekt | Dátovy 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?ity filter stavu vo vyh?adávaní |
| data.options.total | Celé ?íslo | Celkovy po?et záznamov |
| data.options.total_pages | Celé ?íslo | Celkovy 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"
}
Vysledok 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",
}
