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",
}
