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