Bulk Whois API User Guide (old) | Documentation | Bulk WHOIS API | WhoisXML API

Guide de l'utilisateur de Bulk Whois API (ancien)

Bulk Whois API fournit des enregistrements Whois pour une liste de domaines/IP via une requête API REST unique. Elle est conçue pour la communication de serveur à serveur entre votre système et le réseau WhoisXmlApi.com en utilisant les protocoles HTTP ou HTTPS. Les réponses aux requêtes sont livrées au format XML ou JSON en fonction de vos requêtes qui qui sont faites via des méthodes POST.

Pour commencer, vous avez besoin d'un compte sur WhoisXmlApi.com. L'authentification est requise à chaque fois pour pour utiliser l'API. Les 500 premiers appels API Whois en masse sont gratuits lorsque vous vous inscrivez pour un compte gratuit.

Appeler le service web de Bulk Whois API

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/bulkWhois

Fournir les paramètres encodés en JSON dans le corps de la requête, en définissant l'en-tête Content-Type à application/json. La réponse du serveur contiendra le champ requestId dont vous aurez besoin pour récupérer les enregistrements WHOIS demandés.

Exemple de réponse JSON

{
  "domains": [
    "google.com",
    "yahoo.com"
  ],
  "username": "your_username",
  "password": "********",
  "outputFormat": "JSON"
}

Paramètres d'entrée

domains

Requis. Tableau de domaines pour lesquels des données WHOIS sont demandées.

username

Obligatoire. Nom d'utilisateur de votre compte

password

Obligatoire. Le mot de passe de votre compte.

Veillez à ce qu'il soit codé en URL s'il contient des caractères spéciaux (&, %, *, etc.).

outputFormat

Format de sortie de la réponse.

Valeurs acceptables : JSON | XML

Par défaut : XML

Exemple de sortie

{
  "noDataAvailable": false,
  "message": "OK",
  "messageCode": 200,
  "requestId": "ece0f949-c22a-4ecc-..."
}

Obtenir les enregistrements Whois

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getRecords

Comme le traitement de tous les domaines d'entrée peut prendre un certain temps, vous devrez interroger cette ressource à plusieurs reprises jusqu'à ce que jusqu'à ce que les recordsLeft soit égale à 0.

Définir la valeur de maxRecords à 1 si vous n'avez pas besoin de suivre la progression de chaque enregistrement.

Dans le cas contraire, chaque élément du tableau whoisRecords contient le paramètre whoisRecordStatus :

  • 0 - traité ;
  • 1/2 - données incomplètes / manquantes ;
  • 3 - traitement.

Exemple de demande JSON

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "maxRecords": 1,
  "username": "your_username",
  "password": "********",
  "startIndex": 1,
  "outputFormat": "JSON"
}

Paramètres d'entrée

username

Obligatoire. Nom d'utilisateur de votre compte

password

Obligatoire. Le mot de passe de votre compte.

Veillez à ce qu'il soit codé en URL s'il contient des caractères spéciaux (&, %, *, etc.).

requestId

Obligatoire. String.

Identifiant de la demande groupée.

maxRecords

Obligatoire. Nombre.

Nombre maximal d'enregistrements WHOIS à renvoyer.

startIndex

Optionnel. Nombre.

Le premier enregistrement WHOIS renvoyé par le serveur.

Valeurs acceptables : 1+

Valeur par défaut : 1

outputFormat

Facultatif. Format de sortie de la réponse.

Valeurs acceptables : JSON | XML

Par défaut : XML

Téléchargement des résultats au format CSV

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/download

Exemple de demande JSON

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "username": "your_username",
  "password": "********",
  "searchType": "all"
}

Paramètres d'entrée

username

Obligatoire. Nom d'utilisateur de votre compte

password

Obligatoire. Le mot de passe de votre compte.

Veillez à ce qu'il soit codé en URL s'il contient des caractères spéciaux (&, %, *, etc.).

requestId

Obligatoire. String.

Identifiant de la demande groupée.

searchType

Facultatif. string.

noError vous permet de filtrer les enregistrements contenant des erreurs de traitement, aucune donnée, etc.

Valeurs acceptables : all | noError

Valeur par défaut : all

Récupérer la liste de vos demandes

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getUserRequests

Exemple de demande JSON

{
  "noDataAvailable": false,
  "userRequests": [
    {
      "requestId": "f1008d3e-7774-495b-...",
      "time": 1498282373092,
      "status": "Completed",
      "totalRecords": 4,
      "fetchedRecords": 0
    }
  ]
}

Paramètres d'entrée

username

Obligatoire. Nom d'utilisateur de votre compte

password

Obligatoire. Le mot de passe de votre compte.

Veillez à ce qu'il soit codé en URL s'il contient des caractères spéciaux (&, %, *, etc.).

outputFormat

Facultatif. Format de sortie de la réponse.

Valeurs acceptables : JSON | XML

Par défaut : XML

Accès gratuit

Après l'inscription, vous bénéficiez automatiquement d'un plan d'abonnement gratuit limité à 500.