Email-API — E-Mail-Adresse validieren (REST)

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um eine E-Mail-Adresse zu validieren und Informationen zu ihrer Syntax, Domain und ihrem Aktivitätsstatus zu erhalten.

Zugehörige Restful-Email-Dokumentation:

GET-Anfrage

Endpunkt

GET https://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&CheckUser={CHECK_USER}&TimeOut={TIME_OUT}

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Angaben.

Parameter Beschreibung Erforderlich/Optional
Email Zu validierende E-Mail-Adresse. Erforderlich
Licence Ihrem Konto zugewiesener Lizenzcode. Erforderlich
Rectify Y, um einen Korrekturvorschlag zu erhalten, wenn die Syntax ungültig oder die Domain unbekannt ist. Optional
CheckUser N, wenn der Teil vor dem @-Zeichen (Benutzername) nicht geprüft werden soll. Optional
TimeOut Maximale Abfragezeit für die Prüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional

POST-Anfrage

Endpunkt

POST https://{SERVER_ADDRESS}/{VERSION}/lookupemail/

Fügen Sie die folgenden Parameter im Body der Anfrage im Format x-www-form-urlencoded hinzu.

Parameter Beschreibung Erforderlich/Optional
Email Zu validierende E-Mail-Adresse. Erforderlich
Licence Ihrem Konto zugewiesener Lizenzcode. Erforderlich
Rectify Y, um einen Korrekturvorschlag zu erhalten, wenn die Syntax ungültig oder die Domain unbekannt ist. Optional
CheckUser N, wenn der Teil vor dem @-Zeichen (Benutzername) nicht geprüft werden soll. Optional
TimeOut Maximale Abfragezeit für die Prüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional

Antwort

Erfolgreiche Antwort

Die JSON-Antwort ist ein Dictionary mit der Anzahl der Ergebnisse und einem Array der validierten E-Mail-Adressen.

Schlüssel Beschreibung Typ
Found Anzahl der zurückgegebenen E-Mail-Adressen. INTEGER
Emails Array der Validierungsergebnisse, ein Eintrag pro übermittelter E-Mail-Adresse. ARRAY
ActivityCode Aktivitätsstatus der E-Mail-Adresse. Siehe Referenz der API-Antwortcodes. STRING
IdError Rückgabecode der Validierung. Siehe Referenz der API-Antwortcodes. STRING
Corrected 1, wenn eine Korrektur angewendet wurde; sonst 0. INTEGER
SuggestedEmail Korrigierte E-Mail-Adresse, zurückgegeben, wenn Rectify=Y gesetzt ist und eine Korrektur gefunden wurde. STRING
InputEmail In der Anfrage übermittelte E-Mail-Adresse. STRING

Beispiel:

{
  "Found": 1,
  "Emails": [
    {
      "ActivityCode": "",
      "IdError": "02",
      "Corrected": 0,
      "SuggestedEmail": "toto@gmail.com",
      "InputEmail": "toto@gmail.com"
    }
  ]
}

Fehlerantwort

Fehlertyp Antworttyp
Fehlender oder leerer Pflichtparameter 400 Bad Request
Ungültige oder nicht autorisierte Lizenz 401 Unauthorized

Beispiel (400):

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Email",
  "error": "bad request"
}

Beispiel (401):

{
  "status": 401,
  "message": "Your licence is not allowed to cover this functionnality",
  "details": "{WRONG LICENSE}",
  "error": "unauthorized_client"
}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich