Advanced API docs | Documentation | Registrant Alert API | WhoisXML API

Formuler des demandes

API endpoint

POST https://registrant-alert.whoisxmlapi.com/api/v2
L'activation de votre compte après l'enregistrement prend jusqu'à une minute.

Notez que les résultats de la recherche sont limités à 10 000 enregistrements. Si vous souhaitez obtenir des résultats plus pertinents, essayez d'optimiser votre requête de recherche ou d'utiliser la recherche avancée.

Collection de Postman

Postman est une application web et de bureau qui vous permet de faire des demandes à une API à partir d'une interface utilisateur graphique. Nous recommandons d'utiliser Postman avec les points d'extrémité des API WhoisXML pour explorer les fonctionnalités des API, ainsi que pour résoudre les problèmes liés à votre application.

La collection Postman de l'API WhoisXML est disponible aux liens suivants :

La collection comprend un environnement préconfiguré. Vous devrez configurer la clé_api pour déclencher chaque requête. Obtenez votre CLÉ d'API personnelle sur la page Mes produits. Si vous avez des questions relatives à l'API, contactez-nous.

Exemple de corps de requête POST

{
    "apiKey": "API_KEY",
    "sinceDate": "2019-04-20",
    "mode": "purchase",
    "advancedSearchTerms": [{
        "field": "RegistrantContact.Organization",
        "term": "Airbnb, Inc.",
        "exactMatch": true
    },
    {
        "field": "RegistrantContact.Country",
        "term": "UNITED STATES"
    }]
}

La recherche de base nécessite moins de configuration et produit des résultats plus larges. La recherche avancée permet d'effectuer des recherches dans des champs spécifiques du WHOIS.

Vous pouvez indiquer jusqu'à quatre termes de recherche dans une même demande. Avec plusieurs termes de recherche, le résultat comprend les domaines qui correspondent à chacun d'entre eux.

Le terme de recherche comprend un champ exact de l'enregistrement WHOIS du domaine, l'un des suivants :

Domaines communs

E-mail

Le Courriel permet d'effectuer une recherche sur RegistrantContact.Email, AdminContact.Email, BillingContact.Email, TechContact.Email en une seule requête.

Champs de contact du déclarant

RegistrantContact.City, RegistrantContact.Country, RegistrantContact.Email, RegistrantContact.Fax, RegistrantContact.FaxExtension, RegistrantContact.Name, RegistrantContact.Organization, RegistrantContact.PostalCode, RegistrantContact.State, RegistrantContact.StreetAddress, RegistrantContact.Telephone, RegistrantContact.TelephoneExtension

Champs de contact administratif

AdminContact.City, AdminContact.Country, AdminContact.Email, AdminContact.Fax, AdminContact.FaxExtension, AdminContact.Name, AdminContact.Organization, AdminContact.PostalCode, AdminContact.State, AdminContact.StreetAddress, AdminContact.Telephone, AdminContact.TelephoneExtension

Champs de contact pour la facturation

BillingContact.City, BillingContact.Country, BillingContact.Email, BillingContact.Fax, BillingContact.FaxExtension, BillingContact.Name, BillingContact.Organization, BillingContact.PostalCode, BillingContact.State, BillingContact.StreetAddress, BillingContact.Telephone, BillingContact.TelephoneExtension

Champs de contact technique

TechContact.City,
TechContact.Pays,
TechContact.Email,
TechContact.Fax,
TechContact.FaxExtension,
TechContact.Nom,
TechContact.Organisation,
TechContact.PostalCode,
TechContact.State,
TechContact.StreetAddress,
TechContact.Telephone,
TechContact.TelephoneExtension

En-têtes

X-Authentication-Token

Vous pouvez utiliser cet en-tête ou le paramètre apiKey pour les appels à l'API.

Obtenez votre CLÉ d'API personnelle sur la page Mes produits.

Paramètres d'entrée pour la recherche avancée

Pour la recherche avancée, au lieu du bloc basicSearchTerms, utilisez le bloc advancedSearchTerms au format suivant :

advancedSearchTerms.field

Obligatoire. Champ WHOIS dans lequel la recherche doit être effectuée.

advancedSearchTerms.term

Obligatoire. Search string. Case insensitive.

advancedSearchTerms.exactMatch

Facultatif. Boolean. Indique si le champ doit correspondre exactement au terme de recherche. Si la réponse est "false", le champ est autorisé à contenir un terme de recherche sous forme de sous-chaîne.

Valeurs acceptables : false | true

Default : false

Notez qu'actuellement, le paramètre n'est pris en charge que pour les champs suivants : RegistrantContact.Name, RegistrantContact.Organization, RegistrantContact.StreetAddress, AdminContact.Name, AdminContact.Organization, AdminContact.StreetAddress, BillingContact.Name, BillingContact.Organization, BillingContact.StreetAddress, TechContact.Name, TechContact.Organization, TechContact.Street

Pour tous les autres champs, il est ignoré et interprété comme "true".