Anfragen stellen

Postboten Kollektion

Postman ist eine Desktop- und Webanwendung, mit der Sie über eine grafische Benutzeroberfläche Anfragen an eine API stellen können. Wir empfehlen die Verwendung von Postman mit den Endpunkten der WhoisXML-APIs, wenn Sie die Funktionalität der APIs erkunden möchten, oder wenn Sie Probleme mit Ihrer Anwendung beheben möchten.

Die WhoisXML API Postman-Sammlung ist unter den folgenden Links verfügbar:

Die Sammlung enthält eine vorkonfigurierte Umgebung. Sie müssen den api_key Variable einrichten, um jede Anfrage auszulösen. Sie erhalten Ihren persönlichen API-Schlüssel auf der Seite Meine Produkte. Wenn Sie Fragen haben im Zusammenhang mit der API haben, kontaktieren Sie uns.

Erstellen Sie eine neue Anfrage

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

Um E-Mail-Listen mit der Bulk-API zu überprüfen, laden Sie bitte zunächst die E-Mails auf den Server hoch, wodurch eine Anfrage erstellt und Ihnen die entsprechende ID zurückgegeben wird. Anschließend können Sie diese ID verwenden, um den Status der Anfrage abzufragen, Ergebnisse herunterzuladen usw.

Die API erwartet, dass die Parameter im Hauptteil jeder Anfrage JSON-codiert sind.

Beispiel einer CURL-Anfrage

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

Beispiel für einen POST-Anfragetext

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

Eingabe-Parameter

apiKey

Erforderlich. Sie erhalten Ihren persönlichen API-Schlüssel auf der Seite Meine Produkte.

Emails

Erforderlich. Array.

Enthält eine Reihe von E-Mail-Adressen zur Verifizierung.

Format

Optional. Zeichenfolge.

Wird verwendet, um das Antwortformat anzugeben.

Erlaubte Werte: "xml", "json", "csv".

Standardwert: "json".

Beispielhafte Ausgabe

{
    "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.
Antwort

Das Antwortobjekt.

Enthält bei Erfolg das Integer-Feld 'id'.

Im Falle eines Fehlers enthält es dessen Beschreibung im Feld 'Fehler'. Wenn es mehrere Fehler gibt, werden deren Beschreibungen im Array 'Fehler' zurückgegeben.

id

Ganzzahlig.

Neu erstellte ID der Verifizierungsanfrage.

Fehler

String.

Fehlerbeschreibung.

Fehler

Array.

Mehrere Fehlermeldungen.