API documentation
Llista Dominis
Obtén la llista de dominis de l'usuari, amb suport per a paginació, ordenació i filtres d’estat
Content-Type
application-json
categoria
domain
acció
domain_list
Paràmetres de la sol·licitud
| Nom del paràmetre | Tipus | Descripció | Exemple |
|---|---|---|---|
| sort | Cadena (opcional) | Mètode d’ordenació: name_asc (ordre ascendent per nom de domini), name_desc (ordre descendent per nom de domini), time_asc (ordre ascendent per data de registre), time_desc (ordre descendent per data de registre, per defecte) | time_desc |
| page_size | Enter (opcional) | Nombre d’elements per pàgina (per defecte: 10, disponibles: 10, 20, 30, 50, 100) | 20 |
| page_index | Enter (opcional) | Número de pàgina (per defecte: 1) | 1 |
| status | Cadena (opcional) | Estat del domini: all (tots els dominis, per defecte), active (dominins actius), expired (dominins caducats), stop (dominins aturats) | active |
| hold | Cadena (opcional) | Estat de bloqueig del domini: cadena buida (sense filtres, predeterminat), 0 (estat sense bloqueig), 1 (estat de bloqueig) | 0 |
Paràmetres de resposta
| Nom del paràmetre | Tipus | Descripció |
|---|---|---|
| code | Enter | Codi d'estat (200 indica èxit) |
| msg | Text | Missatge |
| data | Objecte | Objecte de dades que conté la llista de dominis i opcions |
| data.options | Objecte | Opcions de consulta que inclouen ordre, paginació i filtres |
| data.options.sort | Text | Mètode d’ordenació usat a la consulta |
| data.options.page_size | Enter | Nombre d’elements per pàgina |
| data.options.page_index | Enter | Número de pàgina actual |
| data.options.status | Text | Filtre d'estat aplicat a la consulta |
| data.options.total | Enter | Nombre total de registres |
| data.options.total_pages | Enter | Nombre total de pàgines |
| data.domain_list | Array | Array d'objectes de domini |
| data.domain_list.domain | Text | Nom de domini |
| data.domain_list.created_date | Data | Data de creació (YYYY-MM-DD) |
| data.domain_list.expired_date | Data | Data d'expiració (YYYY-MM-DD) |
| data.domain_list.status | Text | Estat del domini (actiu/expirat/aturat) |
| data.domain_list.nameservers | Array | Array de servidors DNS |
| data.domain_list.hold | Enter | Estat de retenció (0=no retenció, 1=retenció) |
Exemple de sol·licitud
{
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 retornat
0 OK
Resposta correcta
{
"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 Sol·licitud incorrecta
{
"code": 400,
"msg" : "Request parameter error",
}
