API documentation
Seznam Domene
Pridobi seznam domen uporabnika, podpira paginacijo, razvrščanje in filtriranje po statusu
Vsebina-tip
application-json
kategorija
domain
dejanje
domain_list
Zahtevani parametri
| Ime parametra | Vrsta | Opis | Primer |
|---|---|---|---|
| sort | Niz (neobvezno) | Metoda razvrščanja: name_asc (naraščajoče po imenu domene), name_desc (padajoče po imenu domene), time_asc (naraščajoče po času registracije), time_desc (padajoče po času registracije, privzeto) | time_desc |
| page_size | Celo število (neobvezno) | Število elementov na stran (privzeto: 10, podprto: 10, 20, 30, 50, 100) | 20 |
| page_index | Celo število (neobvezno) | Številka strani (privzeto: 1) | 1 |
| status | Niz (neobvezno) | Status domene: all (vse domene, privzeto), active (aktivne domene), expired (potekle domene), stop (zaustavljene domene) | active |
| hold | Niz (neobvezno) | Stanje domene na čakanju: prazno (brez filtriranja, privzeto), 0 (brez čakanja), 1 (stanje na čakanju) | 0 |
Parametri odgovora
| Ime parametra | Vrsta | Opis |
|---|---|---|
| code | Celo število | Koda stanja (200 pomeni uspeh) |
| msg | Niz | Sporočilo |
| data | Objekt | Podatkovni objekt, ki vsebuje seznam domen in nastavitve |
| data.options | Objekt | Možnosti poizvedbe, vključno z razvrščanjem, straničenjem in filtriranjem |
| data.options.sort | Niz | Metoda razvrščanja, uporabljena v poizvedbi |
| data.options.page_size | Celo število | Število elementov na stran |
| data.options.page_index | Celo število | Trenutna številka strani |
| data.options.status | Niz | Na poizvedbo je uporabljen statusni filter |
| data.options.total | Celo število | Skupno število zapisov |
| data.options.total_pages | Celo število | Skupno število strani |
| data.domain_list | Polje | Polje domen |
| data.domain_list.domain | Niz | Ime domene |
| data.domain_list.created_date | Datum | Datum ustvarjanja (LLLL-MM-DD) |
| data.domain_list.expired_date | Datum | Datum poteka (LLLL-MM-DD) |
| data.domain_list.status | Niz | Status domene (aktivna/potekla/ustavi) |
| data.domain_list.nameservers | Polje | Nabor DNS strežnikov |
| data.domain_list.hold | Celo število | Status zadržanja (0=ni zadržan, 1=zadržan) |
Primer zahteve
{
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"
}
Rezultat vrnitve
0 OK
Uspešen odgovor
{
"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 Napačna zahteva
{
"code": 400,
"msg" : "Request parameter error",
}
