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

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um eine Liste von E-Mail-Adressvorschlägen basierend auf Vorname, Nachname und den bereits vom Benutzer im E-Mail-Feld eingegebenen Zeichen zu erhalten.

Zugehörige Restful-Email-Dokumentation:

GET-Anfrage

Endpunkt

GET https://{SERVER_ADDRESS}/{VERSION}/emailsuggest/?FirstName={FIRST_NAME}&LastName={LAST_NAME}&Email={EMAIL}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}

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

Parameter Beschreibung Erforderlich/Optional
FirstName Vom Benutzer eingegebener Vorname. Erforderlich
LastName Vom Benutzer eingegebener Nachname. Erforderlich
Email Vom Benutzer bereits eingegebener Teil der E-Mail-Adresse. Erforderlich
Country ISO-3-Buchstaben-Ländercode. Erforderlich
Licence Ihrem Konto zugewiesener Lizenzcode. Erforderlich

POST-Anfrage

Endpunkt

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

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

Parameter Beschreibung Erforderlich/Optional
FirstName Vom Benutzer eingegebener Vorname. Erforderlich
LastName Vom Benutzer eingegebener Nachname. Erforderlich
Email Vom Benutzer bereits eingegebener Teil der E-Mail-Adresse. Erforderlich
Country ISO-3-Buchstaben-Ländercode. Erforderlich
Licence Ihrem Konto zugewiesener Lizenzcode. Erforderlich

Antwort

Erfolgreiche Antwort

Die JSON-Antwort ist ein Dictionary mit der Anzahl der Ergebnisse und einem Array von E-Mail-Vorschlägen.

Schlüssel Beschreibung Typ
Found Anzahl der zurückgegebenen Vorschlagsergebnisse. INTEGER
Suggestion Array der Vorschlagsergebnisse. ARRAY
Instance Benutzerdefinierter Wert, der unverändert in der Antwort zurückgegeben wird. STRING
InputEmail In der Anfrage übermittelter E-Mail-Wert. STRING
Syntaxe ok oder ko, je nach Syntax der bereits eingegebenen E-Mail. STRING
List Liste der vorgeschlagenen E-Mail-Adressen. ARRAY
ListCount Anzahl der vorgeschlagenen E-Mail-Adressen in List. INTEGER

Beispiel:

{
  "Found": 1,
  "Suggestion": [
    {
      "Instance": "0",
      "InputEmail": "",
      "Syntaxe": "ok",
      "List": [
        "jlim@"
      ],
      "ListCount": 8
    }
  ]
}

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": "FirstName",
  "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

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich