Realizar solicitudes

Colección Postman

Postman es una aplicación web y de escritorio que permite realizar llamadas a la API desde una interfaz gráica. Le recomendamos que utilice Postmancon los puntos finales de las API de WhoisXML cuando explore la funcionalidad de las API, así como cuando esté identificando problemas con su aplicación.

La compilación Postman de API de WhoisXML está disponible en los siguientes enlaces:

La compilación incluye un entorno preconfigurado. Tendrá que configurar la api_key para realizar cada solicitud. Obtenga su clave de API personal en la página Mis productos. Si tiene preguntas relacionadas con la API, póngase en contacto con nosotros.

Crear una nueva solicitud

POST https://emailverification.whoisxmlapi.com/api/bevService/request

Para comprobar listas de correos electrónicos con la API masiva, primero suba los correos electrónicos al servidor, lo que creará una solicitud y le devolverá su ID. A continuación, puede utilizar este ID para consultar el estado de la solicitud, descargar los resultados, etc.

La API espera que los parámetros estén codificados en JSON en el cuerpo de cada solicitud.

Muestra de solicitud CURL

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "emails": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

Ejemplo de cuerpo de solicitud POST

{
    "apiKey": "YOUR_API_KEY",
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

Parámetros de entrada

apiKey

Obligatorio. Obtenga su clave API personal en la página Mis productos.

emails

Obligatorio. Matriz.

Contiene una matriz de direcciones de correo para su verificación.

format

Opcional. Cadena.

Se utiliza para especificar el formato de respuesta.

Valores permitidos: "xml", "json", "csv".

Valor por defecto: "json".

Muestra de salida

{
    "response": {
        "id": 5
    }
}

Code: 200 OK.
{
    "response": {
        "errors": [
            "The format field should have one of the following values: json, xml."
        ]
    }
}

Code: 400 Bad Request.
{
    "response": {
        "error": "Authorisation or authentication failed"
    }
}

Code: 401 Unauthorized.
{
    "response": {
        "error": "Insufficient balance"
    }
}

Code: 402 Payment Required.
response

El objeto de respuesta.

Contiene el campo íntegro 'id' en caso de éxito.

En caso de error, contiene su descripción en el campo 'error'. Si hay varios errores se devuelven sus descripciones en la matriz 'errors'.

id

Íntegro.

ID de solicitud de verificación recién creada.

error

Cadena.

Descripción del error.

errors

Matriz.

Múltiples mensajes de error.