API documentation
List Dominios
Obtener la lista de dominios del usuario, compatible con paginación, ordenación y filtrado por estado
Content-Type
application-json
categoría
domain
acción
domain_list
Parámetros de Solicitud
| Nombre del Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| sort | Cadena (Opcional) | Método de ordenación: name_asc (nombre de dominio ascendente), name_desc (nombre de dominio descendente), time_asc (tiempo de registro ascendente), time_desc (tiempo de registro descendente, predeterminado) | time_desc |
| page_size | Entero (Opcional) | Número de elementos por página (predeterminado: 10, compatibles: 10, 20, 30, 50, 100) | 20 |
| page_index | Entero (Opcional) | Número de página (predeterminado: 1) | 1 |
| status | Cadena (Opcional) | Estado del dominio: all (todos los dominios, predeterminado), active (dominios activos), expired (dominios expirados), stop (dominios detenidos) | active |
| hold | Cadena (Opcional) | Estado de retención del dominio: cadena vacía (sin filtrado, predeterminado), 0 (sin retención), 1 (en retención) | 0 |
Parámetros de Respuesta
| Nombre del Parámetro | Tipo | Descripción |
|---|---|---|
| code | Entero | Código de estado (200 indica éxito) |
| msg | Cadena | Mensaje |
| data | Objeto | Objeto de datos que contiene la lista de dominios y opciones |
| data.options | Objeto | Opciones de consulta que incluyen ordenación, paginación y configuración de filtros |
| data.options.sort | Cadena | Método de ordenación utilizado en la consulta |
| data.options.page_size | Entero | Número de elementos por página |
| data.options.page_index | Entero | Número de página actual |
| data.options.status | Cadena | Filtro de estado aplicado a la consulta |
| data.options.total | Entero | Número total de registros |
| data.options.total_pages | Entero | Número total de páginas |
| data.domain_list | Arreglo | Arreglo de objetos de dominio |
| data.domain_list.domain | Cadena | Nombre de dominio |
| data.domain_list.created_date | Fecha | Fecha de creación (AAAA-MM-DD) |
| data.domain_list.expired_date | Fecha | Fecha de expiración (AAAA-MM-DD) |
| data.domain_list.status | Cadena | Estado del dominio (activo/expirado/detenido) |
| data.domain_list.nameservers | Arreglo | Arreglo de servidores DNS |
| data.domain_list.hold | Entero | Estado de retención (0=sin retención, 1=en retención) |
Ejemplo de Solicitud
{
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"
}
Resultado Devuelto
0 OK
Respuesta Exitosa
{
"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 Solicitud Incorrecta
{
"code": 400,
"msg" : "Request parameter error",
}






