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 | Стринг (по избор) | Статус на домейн: всички (всички домейни, по подразбиране), активни (активни домейни), изтекли (изтекли домейни), стоп (спряни домейни) | 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",
}
