API documentation
Lista Domínios
Obtenha a lista de domínios do usuário, com suporte para paginação, ordenação e filtragem por status
Content-Type
application-json
categoria
domain
ação
domain_list
Parâmetros da solicitação
| Nome do parâmetro | Tipo | Descreva | Exemplo |
|---|---|---|---|
| sort | String (Opcional) | Método de ordenação: name_asc (nome de domínio em ordem crescente), name_desc (nome de domínio em ordem decrescente), time_asc (tempo de registro em ordem crescente), time_desc (tempo de registro em ordem decrescente, padrão) | time_desc |
| page_size | Inteiro (Opcional) | Número de itens por página (padrão: 10, suportado: 10, 20, 30, 50, 100) | 20 |
| page_index | Inteiro (Opcional) | Número da página (padrão: 1) | 1 |
| status | String (Opcional) | Status do domínio: all (todos os domínios, padrão), active (domínios ativos), expired (domínios expirados), stop (domínios suspensos) | active |
| hold | String (Opcional) | Estado de suspensão do domínio: string vazia (sem filtragem, padrão), 0 (estado não suspenso), 1 (estado suspenso) | 0 |
Parâmetros da resposta
| Nome do parâmetro | Tipo | Descreva |
|---|---|---|
| code | Inteiro | Código de status (200 indica sucesso) |
| msg | String | Mensagem |
| data | Objeto | Objeto de dados contendo a lista de domínios e opções |
| data.options | Objeto | Opções de consulta incluindo configurações de ordenação, paginação e filtragem |
| data.options.sort | String | Método de ordenação usado na consulta |
| data.options.page_size | Inteiro | Número de itens por página |
| data.options.page_index | Inteiro | Número da página atual |
| data.options.status | String | Filtro de status aplicado à consulta |
| data.options.total | Inteiro | Número total de registros |
| data.options.total_pages | Inteiro | Número total de páginas |
| data.domain_list | Array | Array de objetos de domínio |
| data.domain_list.domain | String | Nome de domínio |
| data.domain_list.created_date | Data | Data de criação (YYYY-MM-DD) |
| data.domain_list.expired_date | Data | Data de expiração (YYYY-MM-DD) |
| data.domain_list.status | String | Status do domínio (ativo/expirado/parado) |
| data.domain_list.nameservers | Array | Array de servidores DNS |
| data.domain_list.hold | Inteiro | Status de hold (0=sem hold, 1=hold) |
Exemplo de solicitação
{
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 retornado
0 OK
Resposta bem-sucedida
{
"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 Solicitação inválida
{
"code": 400,
"msg" : "Request parameter error",
}
