API documentation
Listahan Mga Domain
Kunin ang listahan ng domain ng user, may suporta sa pagination, sorting, at pag-filter ayon sa status
Content-Type
application-json
kategorya
domain
aksyon
domain_list
Mga parameter ng request
| Pangalan ng parameter | Uri | Paglalarawan | Halimbawa |
|---|---|---|---|
| sort | String (Opsyonal) | Pamamaraan ng pag-uuri: name_asc (pataas na ayos ng domain name), name_desc (pababa na ayos ng domain name), time_asc (pataas na ayos ng oras ng pagpaparehistro), time_desc (pababa na ayos ng oras ng pagpaparehistro, default) | time_desc |
| page_size | Integer (Opsyonal) | Bilang ng mga item bawat pahina (default: 10, supported: 10, 20, 30, 50, 100) | 20 |
| page_index | Integer (Opsyonal) | Numero ng pahina (default: 1) | 1 |
| status | String (Opsyonal) | Status ng domain: all (lahat ng domain, default), active (mga aktibong domain), expired (mga expired na domain), stop (mga nakahintong domain) | active |
| hold | String (Opsyonal) | Status ng domain hold: blangkong string (walang pag-filter, default), 0 (non-hold status), 1 (hold status) | 0 |
Mga parameter ng tugon
| Pangalan ng parameter | Uri | Paglalarawan |
|---|---|---|
| code | Integer | Status code (200 ang ibig sabihin ay success) |
| msg | String | Mensahe |
| data | Bagay | Data object na naglalaman ng listahan ng domain at mga opsyon |
| data.options | Bagay | Mga opsyon sa query kabilang ang pag-sort, pagination, at mga setting ng pag-filter |
| data.options.sort | String | Paraan ng pag-sort na ginagamit sa query |
| data.options.page_size | Integer | Bilang ng mga item bawat page |
| data.options.page_index | Integer | Kasalukuyang numero ng pahina |
| data.options.status | String | Nailapat na filter ng status sa query |
| data.options.total | Integer | Kabuuang bilang ng mga record |
| data.options.total_pages | Integer | Kabuuang bilang ng mga pahina |
| data.domain_list | Array | Array ng mga object ng domain |
| data.domain_list.domain | String | Pangalan ng domain |
| data.domain_list.created_date | Petsa | Petsa ng paglikha (YYYY-MM-DD) |
| data.domain_list.expired_date | Petsa | Petsa ng pag-expire (YYYY-MM-DD) |
| data.domain_list.status | String | Status ng domain (active/expired/stop) |
| data.domain_list.nameservers | Array | Hanay ng DNS server |
| data.domain_list.hold | Integer | Status ng hold (0=non-hold, 1=hold) |
Halimbawa ng Request
{
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"
}
Resulta ng Return
0 OK
Matagumpay na tugon
{
"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 Hindi wastong kahilingan
{
"code": 400,
"msg" : "Request parameter error",
}
