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 | ???????? (????????) | ????? ??????: all (??? ?????, ????????), active (?????? ?????), expired (?????? ?????), stop (???? ??? ?????) | active |
| hold | ???????? (????????) | ????? ????? ??????: ???? ???????? (??? ??????? ????, ????????), 0 (non-hold ??????), 1 (hold ??????) | 0 |
??????????? ????????
| ???????? ??? | ?????? | ????? |
|---|---|---|
| code | ???????? | ?????? ??? (200 ????? ?? ??????? ??) |
| msg | ???????? | Message |
| 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 | ??? | domain objects ?? 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 | ??? | 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",
}
