Domaine API v2 | Powerful Intégration Àols

Start Building with NiceNIC Domaine API v2

API access is free fou every active NiceNIC user. Non reseller upgrade is required. Configure votre API credentials, make a safe test request, then add the domain, DNS, billing, compliance ou WHMCS woukflows votre application needs.

List Domaines

Obtenir la liste des domaines de l'utilisateur, prend en charge la pagination, le tri et le filtrage par statut

Type de contenu application/json

Catégorie domain

Action domain_list

Paramètres de la requête

Nom du paramètre	Type	Description	Exemple
sort	Chaîne (Optionnel)	Méthode de tri : name_asc (nom de domaine croissant), name_desc (nom de domaine décroissant), time_asc (date d'enregistrement croissante), time_desc (date d'enregistrement décroissante, par défaut)	time_desc
page_size	Entier (Optionnel)	Nombre d'éléments par page (par défaut : 10, supporté : 10, 20, 30, 50, 100)	20
page_index	Entier (Optionnel)	Numéro de page (par défaut : 1)	1
status	Chaîne (Optionnel)	Statut du domaine : all (tous les domaines, par défaut), active (domaines actifs), expired (domaines expirés), stop (domaines arrêtés)	active
hold	Chaîne (Optionnel)	Statut de blocage du domaine : chaîne vide (pas de filtrage, par défaut), 0 (non bloqué), 1 (bloqué)	0

Paramètres de la réponse

Nom du paramètre	Type	Description
code	Entier	Code de statut (200 indique succès)
msg	Chaîne	Message
data	Objet	Objet de données contenant la liste de domaines et les options
data.options	Objet	Options de requête incluant tri, pagination et paramètres de filtrage
data.options.sort	Chaîne	Méthode de tri utilisée dans la requête
data.options.page_size	Entier	Nombre d'éléments par page
data.options.page_index	Entier	Numéro de page actuel
data.options.status	Chaîne	Filtre de statut appliqué à la requête
data.options.total	Entier	Nombre total d'enregistrements
data.options.total_pages	Entier	Nombre total de pages
data.domain_list	Tableau	Tableau d'objets domaine
data.domain_list.domain	Chaîne	Nom de domaine
data.domain_list.created_date	Date	Date de création (AAAA-MM-JJ)
data.domain_list.expired_date	Date	Date d'expiration (AAAA-MM-JJ)
data.domain_list.status	Chaîne	Statut du domaine (actif/expiré/arrêté)
data.domain_list.nameservers	Tableau	Tableau des serveurs DNS
data.domain_list.hold	Entier	Statut de blocage (0=non bloqué, 1=bloqué)

Exemple de requête

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

Résultat renvoyé

0 OK Réponse réussie

                                        
{
    "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 Mauvaise requête

                                        
{
    "code": 400,
    "msg" : "Request parameter error",
}