API documentation
Liste Domenenavn
Hent brukerens domenerliste, støtter paginering, sortering og filtrering på status
Innholdstype
application-json
kategori
domain
handling
domain_list
Forespørselsparametere
| Parameter navn | Type | Beskrivelse | Eksempel |
|---|---|---|---|
| sort | Tekststreng (valgfritt) | Sorter metode: name_asc (domenenavn stigende), name_desc (domenenavn synkende), time_asc (registreringstid stigende), time_desc (registreringstid synkende, standard) | time_desc |
| page_size | Heltall (valgfritt) | Antall elementer per side (standard: 10, støttet: 10, 20, 30, 50, 100) | 20 |
| page_index | Heltall (valgfritt) | Sidnummer (standard: 1) | 1 |
| status | Tekststreng (valgfritt) | Domenestatus: all (alle domener, standard), active (aktive domener), expired (utløpte domener), stop (stoppede domener) | active |
| hold | Tekststreng (valgfritt) | Domain hold status: tom streng (ingen filtrering, standard), 0 (ikke hold-status), 1 (hold-status) | 0 |
Svarparametere
| Parameter navn | Type | Beskrivelse |
|---|---|---|
| code | Heltall | Statuskode (200 betyr suksess) |
| msg | Tekst | Melding |
| data | Objekt | Dataobjekt som inneholder domeneliste og innstillinger |
| data.options | Objekt | Forespørselsinnstillinger inkludert sortering, paginering og filtrering |
| data.options.sort | Tekst | Sorteringsmetode brukt i spørringen |
| data.options.page_size | Heltall | Antall elementer per side |
| data.options.page_index | Heltall | Aktuelt sidetall |
| data.options.status | Tekst | Statusfilter brukt på spørringen |
| data.options.total | Heltall | Totalt antall poster |
| data.options.total_pages | Heltall | Totalt antall sider |
| data.domain_list | Array | Array med domenobjekter |
| data.domain_list.domain | Tekst | Domenenavn |
| data.domain_list.created_date | Dato | Opprettelsesdato (ÅÅÅÅ-MM-DD) |
| data.domain_list.expired_date | Dato | Utløpsdato (ÅÅÅÅ-MM-DD) |
| data.domain_list.status | Tekst | Domenestatus (aktiv/utløpt/stopp) |
| data.domain_list.nameservers | Array | Array med DNS-servere |
| data.domain_list.hold | Heltall | Holdstatus (0=ikke hold, 1=hold) |
Forespørselseksempel
{
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"
}
Resultat
0 OK
Vellykket svar
{
"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 Ugyldig forespørsel
{
"code": 400,
"msg" : "Request parameter error",
}
