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