API documentation
Seznam Domény
Získat seznam u?ivatelovych 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, vychozí) | time_desc |
| page_size | Celé ?íslo (volitelné) | Po?et polo?ek na stránku (vychozí: 10, podporováno: 10, 20, 30, 50, 100) | 20 |
| page_index | Celé ?íslo (volitelné) | ?íslo stránky (vychozí: 1) | 1 |
| status | ?etězec (volitelné) | Stav domény: all (v?echny domény, vychozí), active (aktivní domény), expired (expirované domény), stop (zastavené domény) | active |
| hold | ?etězec (volitelné) | Stav zadr?ení domény: prázdny ?etězec (bez filtrování, vychozí), 0 (stav bez zadr?ení), 1 (stav zadr?ení) | 0 |
Parametry odpovědi
| Název parametru | Typ | Popis |
|---|---|---|
| code | Celé ?íslo | Stavovy kód (200 znamená úspěch) |
| msg | ?etězec | Zpráva |
| data | Objekt | Datovy 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?ity 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 | Filtrovany stav v dotazu |
| data.options.total | Celé ?íslo | Celkovy po?et záznam? |
| data.options.total_pages | Celé ?íslo | Celkovy po?et stránek |
| data.domain_list | Pole | Pole doménovych 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áceny vysledek
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 Neplatny po?adavek
{
"code": 400,
"msg" : "Request parameter error",
}
