Guía del usuario de la API Whois masiva (antigua) | Documentación | API WHOIS masiva | API WhoisXML

Guía del usuario de la API Whois masiva (antigua)

Bulk Whois API proporciona registros Whois para una lista de Dominios/IPs a través de una única consulta REST API. Está diseñada para la comunicación de servidor a servidor entre su sistema y la red WhoisXmlApi.com utilizando protocolos estándar HTTP o HTTPS estándar. Las respuestas a las consultas se entregan en formato XML o JSON en función de sus solicitudes, que se realizan a través de métodos POST.

Para empezar necesita una cuenta en WhoisXmlApi.com. La autenticación se requiere cada vez en para poder utilizar la API. Las primeras 500 llamadas a la API Whois a granel son gratuitas cuando se registra para obtener una gratuita.

Realización de una llamada al servicio web API Whois masivo

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

Proporcione los parámetros codificados en JSON en el cuerpo de la solicitud, estableciendo la cabecera Content-Type a application/json. La respuesta del servidor contendrá el campo requestId que necesitará para recuperar los registros WHOIS solicitados.

Ejemplo de respuesta JSON

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

Parámetros de entrada

dominios

Requerido. Una matriz de dominios para los que se solicitan datos WHOIS.

nombre de usuario

Obligatorio. Nombre de usuario de su cuenta

contraseña

Obligatorio. La contraseña de su cuenta.

Asegúrese de que está codificado como URL si contiene caracteres especiales (&, %, *, etc.).

outputFormat

Formato de salida de la respuesta.

Valores aceptados: JSON | XML

Por defecto: XML

Muestra de salida

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

Obtener registros Whois

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

Dado que el procesamiento de todos los dominios de entrada puede llevar algún tiempo, tendrá que consultar repetidamente este recurso hasta que los recordsLeft sea 0.

Establezca el valor maxRecords a 1 si no necesita controlar el progreso de cada registro.

En caso contrario, cada elemento de la matriz whoisRecords contiene el whoisRecordStatus :

  • 0 - procesado;
  • 1/2 - datos incompletos / que faltan;
  • 3 - procesamiento.

Ejemplo de solicitud JSON

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

Parámetros de entrada

nombre de usuario

Obligatorio. Nombre de usuario de su cuenta

contraseña

Obligatorio. La contraseña de su cuenta.

Asegúrese de que está codificado como URL si contiene caracteres especiales (&, %, *, etc.).

requestId

Obligatorio. Cadena.

Identificador de solicitud masiva.

maxRecords

Necesario. Número.

Cantidad máxima de registros WHOIS que se devolverán.

startIndex

Opcional. Número.

El primer registro WHOIS devuelto por el servidor.

Valores aceptables: 1+

Predeterminado: 1

outputFormat

Opcional. Formato de salida de la respuesta.

Valores aceptados: JSON | XML

Por defecto: XML

Descargar CSV de resultados

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

Ejemplo de solicitud JSON

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

Parámetros de entrada

nombre de usuario

Obligatorio. Nombre de usuario de su cuenta

contraseña

Obligatorio. La contraseña de su cuenta.

Asegúrese de que está codificado como URL si contiene caracteres especiales (&, %, *, etc.).

requestId

Obligatorio. Cadena.

Identificador de solicitud masiva.

searchType

Opcional. Cadena.

noError le permite filtrar los registros con errores de procesamiento, sin datos, etc.

Valores aceptables: all | noError

Por defecto: todos

Recuperar la lista de sus solicitudes

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

Ejemplo de solicitud JSON

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

Parámetros de entrada

nombre de usuario

Obligatorio. Nombre de usuario de su cuenta

contraseña

Obligatorio. La contraseña de su cuenta.

Asegúrese de que está codificado como URL si contiene caracteres especiales (&, %, *, etc.).

outputFormat

Opcional. Formato de salida de la respuesta.

Valores aceptados: JSON | XML

Por defecto: XML

Acceso gratuito

Tras registrarse, obtendrá automáticamente un plan de suscripción gratuito limitado a 500 .