E-Mail-Vorschlag - Classic API
Der MAILSUGGEST-Endpunkt schlägt wahrscheinliche E-Mail-Adressen basierend auf Nachname, Vorname und den bereits eingegebenen Zeichen des Benutzers vor, optional ausgerichtet auf in einem bestimmten Land gängige Domains.
Wann dieser Endpunkt verwendet wird - Rufen Sie
MAILSUGGEST auf, während der Benutzer seine E-Mail-Adresse noch eingibt, um auf Basis seines Namens Autovervollständigungsvorschläge anzubieten. Um stattdessen eine vollständige E-Mail-Adresse zu validieren, siehe Email-API — E-Mail-Adresse validieren →
MAILSUGGEST
Anfrage
Sowohl GET als auch POST werden unterstützt.
{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um diese Zugangsdaten zu erhalten.
GEThttps://{SERVER_ADDRESS}/MAILSUGGEST/?Nom={NAME}&Prenom={FIRST_NAME}&Email={EMAIL}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}
Codebeispiele
Testa Testb, noch keine teilweise E-Mail eingegeben
curl "https://{SERVER_ADDRESS}/MAILSUGGEST/?Nom=Testb&Prenom=Testa&Email=&Pays=FRA&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/MAILSUGGEST/?" + new URLSearchParams({
Nom: "Testb",
Prenom: "Testa",
Email: "",
Pays: "FRA",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/MAILSUGGEST/",
params={
"Nom": "Testb",
"Prenom": "Testa",
"Email": "",
"Pays": "FRA",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'Nom' => 'Testb',
'Prenom' => 'Testa',
'Email' => '',
'Pays' => 'FRA',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/MAILSUGGEST/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/MAILSUGGEST/', {
params: {
Nom: 'Testb',
Prenom: 'Testa',
Email: '',
Pays: 'FRA',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/MAILSUGGEST/"
+ "?Nom=Testb&Prenom=Testa&Email=&Pays=FRA&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/MAILSUGGEST/" +
"?Nom=Testb&Prenom=Testa&Email=&Pays=FRA&Licence={LICENCE_CODE}";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/MAILSUGGEST/" +
"?Nom=Testb&Prenom=Testa&Email=&Pays=FRA&Licence={LICENCE_CODE}"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/MAILSUGGEST/
Senden Sie alle Parameter im Request-Body im Format application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
Codebeispiele
Testa Testb, noch keine teilweise E-Mail eingegeben
curl -X POST "https://{SERVER_ADDRESS}/MAILSUGGEST/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "Nom=Testb" \
-d "Prenom=Testa" \
-d "Email=" \
-d "Pays=FRA" \
-d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/MAILSUGGEST/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
Nom: "Testb",
Prenom: "Testa",
Email: "",
Pays: "FRA",
Licence: "{LICENCE_CODE}"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/MAILSUGGEST/",
data={
"Nom": "Testb",
"Prenom": "Testa",
"Email": "",
"Pays": "FRA",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/MAILSUGGEST/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Nom' => 'Testb',
'Prenom' => 'Testa',
'Email' => '',
'Pays' => 'FRA',
'Licence' => '{LICENCE_CODE}',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/MAILSUGGEST/', qs.stringify({
Nom: 'Testb',
Prenom: 'Testa',
Email: '',
Pays: 'FRA',
Licence: '{LICENCE_CODE}'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Nom=Testb&Prenom=Testa&Email=&Pays=FRA&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/MAILSUGGEST/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string> {
["Nom"] = "Testb",
["Prenom"] = "Testa",
["Email"] = "",
["Pays"] = "FRA",
["Licence"] = "{LICENCE_CODE}"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/MAILSUGGEST/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Nom", "Testb")
form.Set("Prenom", "Testa")
form.Set("Email", "")
form.Set("Pays", "FRA")
form.Set("Licence", "{LICENCE_CODE}")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/MAILSUGGEST/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameter
| Parameter | Beschreibung | Erf / Opt |
|---|---|---|
| Nom | Vom Benutzer eingegebener Nachname. Kann leer gelassen werden
|
Erforderlich |
| Prenom | Vom Benutzer eingegebener Vorname. Kann leer gelassen werden
|
Erforderlich |
| Vom Benutzer bereits eingegebener Teil der E-Mail-Adresse. Kann leer gelassen werden
|
Erforderlich | |
| Pays | ISO-3166-1-alpha-3-Ländercode, verwendet, um vorgeschlagene Domains auf ein bestimmtes Land auszurichten. Standard:
FRA
|
Optional |
| Licence | Ihr DQE-Lizenzschlüssel. Wenden Sie sich an den Support, falls Sie noch keinen haben. | Erforderlich |
Antwort
Bei Erfolg gibt die API ein JSON-Objekt mit den vorgeschlagenen E-Mail-Adressen zurück.
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| Instance | Legacy-Feld, nicht mehr verwendet. | String |
| syntaxe |
ok oder ko, je nach Syntax der bereits eingegebenen E-Mail. |
String |
| suggest | Liste der vorgeschlagenen E-Mail-Adressen. | Array |
Antwortbeispiel
Testa Testb, noch keine teilweise E-Mail eingegeben
{
"Instance": "0",
"suggest": [
"ttesta@",
"testat@",
"t.testa@",
"testbtesta@",
"ttestb@",
"testatestb@",
"testa.testb@",
"testb.testa@",
"testb-testa@",
"testa-testb@",
"t-testa@",
"testa-t@"
],
"syntaxe": "ok"
}
Fehler
| HTTP | Fehlertyp | Antwort |
|---|---|---|
| 400 | Fehlender Licence-Parameter |
Bad Request |
| 400 | Leerer Licence-Parameter |
Bad Request |
| — | Falsche Lizenznummer | Leerer Antwortkörper (kein Fehlercode) |
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit