API documentation
فہرست ڈومینز
صارف کی ڈومین فہرست حاصل کریں، pagination، sorting اور status filtering کی سہولت کے ساتھ
Content-Type
application-json
زمرہ
domain
عمل
domain_list
درخواست کے پیرامیٹرز
| پیرامیٹر کا نام | قسم | تفصیل | مثال |
|---|---|---|---|
| sort | String (اختیاری) | ترتیب دینے کا طریقہ: name_asc (domain name صعودی ترتیب)، name_desc (domain name نزولی ترتیب)، time_asc (رجسٹریشن وقت صعودی ترتیب)، time_desc (رجسٹریشن وقت نزولی ترتیب، طے شدہ) | time_desc |
| page_size | Integer (اختیاری) | فی صفحہ آئٹمز کی تعداد (طے شدہ: 10، معاونت یافتہ: 10، 20، 30، 50، 100) | 20 |
| page_index | Integer (اختیاری) | صفحہ نمبر (طے شدہ: 1) | 1 |
| status | String (اختیاری) | domain status: all (تمام domain names، طے شدہ)، active (فعال domain names)، expired (میعاد ختم domain names)، stop (روکے گئے domain names) | active |
| hold | String (اختیاری) | Domain hold status: خالی string (کوئی فلٹرنگ نہیں، طے شدہ)، 0 (non-hold status)، 1 (hold status) | 0 |
جواب کے پیرامیٹرز
| پیرامیٹر کا نام | قسم | تفصیل |
|---|---|---|
| code | عدد صحیح | اسٹیٹس کوڈ (200 کامیابی ظاہر کرتا ہے) |
| msg | اسٹرنگ | پیغام |
| data | آبجیکٹ | ڈومین فہرست اور اختیارات پر مشتمل ڈیٹا آبجیکٹ |
| data.options | آبجیکٹ | استفسار کے اختیارات، جن میں sort، pagination اور filtering کی ترتیبات شامل ہیں |
| data.options.sort | اسٹرنگ | استفسار میں استعمال ہونے والا sort طریقہ |
| data.options.page_size | عدد صحیح | فی صفحہ آئٹمز کی تعداد |
| data.options.page_index | عدد صحیح | موجودہ صفحہ نمبر |
| data.options.status | اسٹرنگ | استفسار پر لاگو status فلٹر |
| data.options.total | عدد صحیح | ریکارڈز کی کل تعداد |
| data.options.total_pages | عدد صحیح | صفحات کی کل تعداد |
| data.domain_list | Array | ڈومین آبجیکٹس کی array |
| data.domain_list.domain | اسٹرنگ | Domain name |
| data.domain_list.created_date | تاریخ | تخلیق کی تاریخ (YYYY-MM-DD) |
| data.domain_list.expired_date | تاریخ | میعاد ختم ہونے کی تاریخ (YYYY-MM-DD) |
| data.domain_list.status | اسٹرنگ | ڈومین اسٹیٹس (active/expired/stop) |
| data.domain_list.nameservers | Array | DNS سرور ارے |
| data.domain_list.hold | عدد صحیح | ہولڈ اسٹیٹس (0=non-hold, 1=hold) |
درخواست کی مثال
{
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",
}
