API documentation
Λίστα Domains
Λήψη λίστας domains χρήστη, με υποστήριξη σελιδοποίησης, ταξινόμησης και φιλτραρίσματος κατά κατάσταση
Content-Type
application-json
κατηγορία
domain
ενέργεια
domain_list
Παράμετροι αιτήματος
| Όνομα παραμέτρου | Τύπος | Περιγραφή | Παράδειγμα |
|---|---|---|---|
| sort | Συμβολοσειρά (Προαιρετικό) | Τρόπος ταξινόμησης: name_asc (αύξουσα κατά όνομα τομέα), name_desc (φθίνουσα κατά όνομα τομέα), time_asc (αύξουσα κατά χρόνο εγγραφής), time_desc (φθίνουσα κατά χρόνο εγγραφής, προεπιλογή) | time_desc |
| page_size | Ακέραιος (Προαιρετικό) | Αριθμός αντικειμένων ανά σελίδα (προεπιλογή: 10, υποστηρίζονται: 10, 20, 30, 50, 100) | 20 |
| page_index | Ακέραιος (Προαιρετικό) | Αριθμός σελίδας (προεπιλογή: 1) | 1 |
| status | Συμβολοσειρά (Προαιρετικό) | Κατάσταση τομέα: all (όλοι οι τομείς, προεπιλογή), active (ενεργοί τομείς), expired (λήξαντες τομείς), stop (διακοπέντες τομείς) | active |
| hold | Συμβολοσειρά (Προαιρετικό) | Κατάσταση κράτησης domain: κενό (χωρίς φιλτράρισμα, προεπιλογή), 0 (μη-κρατούμενη κατάσταση), 1 (κατάσταση κράτησης) | 0 |
Παράμετροι απάντησης
| Όνομα παραμέτρου | Τύπος | Περιγραφή |
|---|---|---|
| code | Ακέραιος | Κωδικός κατάστασης (200 σημαίνει επιτυχία) |
| msg | Συμβολοσειρά | Μήνυμα |
| data | Αντικείμενο | Αντικείμενο δεδομένων που περιέχει λίστα domain και επιλογές |
| data.options | Αντικείμενο | Επιλογές ερωτήματος που περιλαμβάνουν ταξινόμηση, σελιδοποίηση και φίλτρα |
| data.options.sort | Συμβολοσειρά | Μέθοδος ταξινόμησης που χρησιμοποιείται στο ερώτημα |
| data.options.page_size | Ακέραιος | Αριθμός αντικειμένων ανά σελίδα |
| data.options.page_index | Ακέραιος | Τρέχων αριθμός σελίδας |
| data.options.status | Συμβολοσειρά | Φίλτρο κατάστασης εφαρμοσμένο στην αναζήτηση |
| data.options.total | Ακέραιος | Συνολικός αριθμός εγγραφών |
| data.options.total_pages | Ακέραιος | Συνολικός αριθμός σελίδων |
| data.domain_list | Πίνακας | Πίνακας αντικειμένων domain |
| data.domain_list.domain | Συμβολοσειρά | Όνομα domain |
| data.domain_list.created_date | Ημερομηνία | Ημερομηνία δημιουργίας (ΕΕΕΕ-ΜΜ-ΗΗ) |
| data.domain_list.expired_date | Ημερομηνία | Ημερομηνία λήξης (ΕΕΕΕ-ΜΜ-ΗΗ) |
| data.domain_list.status | Συμβολοσειρά | Κατάσταση domain (ενεργό/λήγει/διακοπή) |
| data.domain_list.nameservers | Πίνακας | Πίνακας διακομιστών DNS |
| data.domain_list.hold | Ακέραιος | Κατάσταση κράτησης (0=δεν κρατείται, 1=κρατείται) |
Παράδειγμα Αιτήματος
{
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"
}
Επιστροφή αποτελέσματος
0 OK
Επιτυχής απάντηση
{
"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 Λανθασμένο αίτημα
{
"code": 400,
"msg" : "Request parameter error",
}
