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