API documentation
Lista Verkkotunnukset
Hanki käyttäjän hakemistolista, tukee sivutusta, lajittelua ja tilasuodatusta
Sisältötyyppi
application-json
kategoria
domain
toiminto
domain_list
Pyyntöparametrit
| Parametrin nimi | Tyyppi | Kuvaus | Esimerkki |
|---|---|---|---|
| sort | Merkkijono (valinnainen) | Lajittelutapa: name_asc (domain-nimi nouseva), name_desc (domain-nimi laskeva), time_asc (rekisteröintiaika nouseva), time_desc (rekisteröintiaika laskeva, oletus) | time_desc |
| page_size | Kokonaisluku (valinnainen) | Kohteiden määrä per sivu (oletus: 10, tuetut: 10, 20, 30, 50, 100) | 20 |
| page_index | Kokonaisluku (valinnainen) | Sivunumero (oletus: 1) | 1 |
| status | Merkkijono (valinnainen) | Domainin tila: all (kaikki domainit, oletus), active (aktiiviset domainit), expired (vanhentuneet domainit), stop (pysäytetyt domainit) | active |
| hold | Merkkijono (valinnainen) | Domainin lukitustila: tyhjä merkkijono (ei suodatusta, oletus), 0 (ei lukitusta), 1 (lukitustila) | 0 |
Vastausparametrit
| Parametrin nimi | Tyyppi | Kuvaus |
|---|---|---|
| code | Kokonaisluku | Tilauskoodi (200 tarkoittaa onnistumista) |
| msg | Merkkijono | Viesti |
| data | Objekti | Tieto-objekti, joka sisältää domain-listan ja asetukset |
| data.options | Objekti | Kyselyasetukset, mukaan lukien lajittelu, sivutus ja suodatus |
| data.options.sort | Merkkijono | Kyselyssä käytetty lajittelumenetelmä |
| data.options.page_size | Kokonaisluku | Kohteiden määrä sivulla |
| data.options.page_index | Kokonaisluku | Nykyinen sivunumero |
| data.options.status | Merkkijono | Hakuehtoon sovellettu tilasuodatin |
| data.options.total | Kokonaisluku | Tietueiden kokonaismäärä |
| data.options.total_pages | Kokonaisluku | Sivujen kokonaismäärä |
| data.domain_list | Taulukko | Verkkotunnuskohteiden taulukko |
| data.domain_list.domain | Merkkijono | Verkkotunnus |
| data.domain_list.created_date | Päivämäärä | Luontipäivä (VVVV-KK-PP) |
| data.domain_list.expired_date | Päivämäärä | Voimassaolon päättymispäivä (VVVV-KK-PP) |
| data.domain_list.status | Merkkijono | Verkkotunnuksen tila (aktiivinen/vanhenut/estetty) |
| data.domain_list.nameservers | Taulukko | DNS-palvelinlista |
| data.domain_list.hold | Kokonaisluku | Hold-tila (0=ei hold, 1=hold) |
Pyynnön esimerkki
{
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"
}
Palautettu tulos
0 OK
Onnistunut vastaus
{
"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 Virheellinen pyyntö
{
"code": 400,
"msg" : "Request parameter error",
}
