API documentation
Elenco Domini
Recupera l'elenco domini utente, con supporto a paginazione, ordinamento e filtraggio per stato
Content-Type
application-json
categoria
domain
azione
domain_list
Parametri della richiesta
| Nome parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| sort | Stringa (Facoltativa) | Metodo di ordinamento: name_asc (nome dominio crescente), name_desc (nome dominio decrescente), time_asc (data registrazione crescente), time_desc (data registrazione decrescente, predefinito) | time_desc |
| page_size | Intero (Facoltativo) | Numero di elementi per pagina (predefinito: 10, supportati: 10, 20, 30, 50, 100) | 20 |
| page_index | Intero (Facoltativo) | Numero di pagina (predefinito: 1) | 1 |
| status | Stringa (Facoltativa) | Stato del dominio: all (tutti i domini, predefinito), active (domini attivi), expired (domini scaduti), stop (domini sospesi) | active |
| hold | Stringa (Facoltativa) | Stato di blocco del dominio: stringa vuota (nessun filtro, impostazione predefinita), 0 (stato non bloccato), 1 (stato bloccato) | 0 |
Parametri di risposta
| Nome parametro | Tipo | Descrizione |
|---|---|---|
| code | Numero intero | Codice di stato (200 indica successo) |
| msg | Stringa | Messaggio |
| data | Oggetto | Oggetto dati contenente la lista di domini e opzioni |
| data.options | Oggetto | Opzioni di ricerca tra cui ordinamento, paginazione e filtri |
| data.options.sort | Stringa | Metodo di ordinamento usato nella ricerca |
| data.options.page_size | Numero intero | Numero di elementi per pagina |
| data.options.page_index | Numero intero | Numero di pagina corrente |
| data.options.status | Stringa | Filtro stato applicato alla ricerca |
| data.options.total | Numero intero | Numero totale di record |
| data.options.total_pages | Numero intero | Numero totale di pagine |
| data.domain_list | Array | Array di oggetti dominio |
| data.domain_list.domain | Stringa | Nome dominio |
| data.domain_list.created_date | Data | Data di creazione (AAAA-MM-GG) |
| data.domain_list.expired_date | Data | Data di scadenza (AAAA-MM-GG) |
| data.domain_list.status | Stringa | Stato dominio (attivo/scaduto/bloccato) |
| data.domain_list.nameservers | Array | Array dei server DNS |
| data.domain_list.hold | Numero intero | Stato di blocco (0=non bloccato, 1=bloccato) |
Esempio di richiesta
{
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"
}
Risultato restituito
0 OK
Risposta riuscita
{
"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 Richiesta non valida
{
"code": 400,
"msg" : "Request parameter error",
}
