API documentation
רשימה דומיינים
קבל רשימת דומיינים של המשתמש, כולל דפדוף, מיון ומסנני סטטוס
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 | מחרוזת (אופציונלי) | סטטוס החזקה של דומיין: מחרוזת ריקה (אין סינון, ברירת מחדל), 0 (ללא החזקה), 1 (בסטטוס החזקה) | 0 |
פרמטרי תגובה
| שם פרמטר | סוג | תיאור |
|---|---|---|
| code | מספר שלם | קוד סטטוס (200 מעיד על הצלחה) |
| msg | מחרוזת | הודעה |
| data | אובייקט | אובייקט נתונים שמכיל רשימת דומיינים ואפשרויות |
| 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 | מערך | מערך של אובייקטים של דומיינים |
| data.domain_list.domain | מחרוזת | שם דומיין |
| data.domain_list.created_date | תאריך | תאריך יצירה (שנה-חודש-יום) |
| data.domain_list.expired_date | תאריך | תאריך תפוגה (שנה-חודש-יום) |
| data.domain_list.status | מחרוזת | סטטוס דומיין (פעיל/פג תוקף/עצור) |
| 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",
}
