API documentation
لیست دامنهها
دریافت فهرست دامنههای کاربر، همراه با پشتیبانی از صفحهبندی، مرتبسازی و فیلتر وضعیت
نوع محتوا
application-json
دستهبندی
domain
عملیات
domain_list
پارامترهای درخواست
| نام پارامتر | نوع | توضیح | نمونه |
|---|---|---|---|
| sort | رشته (اختیاری) | روش مرتبسازی: name_asc (صعودی بر اساس نام دامنه)، name_desc (نزولی بر اساس نام دامنه)، time_asc (صعودی بر اساس زمان ثبت)، time_desc (نزولی بر اساس زمان ثبت، پیشفرض) | time_desc |
| page_size | عدد صحیح (اختیاری) | تعداد موارد در هر صفحه (پیشفرض: ۱۰، پشتیبانی شده: ۱۰، ۲۰، ۳۰، ۵۰، ۱۰۰) | 20 |
| page_index | عدد صحیح (اختیاری) | شماره صفحه (پیشفرض: ۱) | 1 |
| status | رشته (اختیاری) | وضعیت دامنه: all (همه دامنهها، پیشفرض)، active (دامنههای فعال)، expired (دامنههای منقضی شده)، stop (دامنههای متوقف شده) | active |
| hold | رشته (اختیاری) | وضعیت نگه داشتن دامنه: رشته خالی (بدون فیلتر، پیشفرض)، ۰ (عدم نگه داشتن)، ۱ (در حالت نگه داشتن) | 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 | تاریخ | تاریخ ایجاد (YYYY-MM-DD) |
| data.domain_list.expired_date | تاریخ | تاریخ انقضا (YYYY-MM-DD) |
| 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",
}
