Sugerencia de Email - API Clásica
El endpoint MAILSUGGEST sugiere posibles direcciones de correo electrónico basándose en el apellido del usuario, su nombre y los caracteres ya introducidos, con un sesgo opcional hacia dominios habituales en un país determinado.
Cuándo usar este endpoint - Llame a
MAILSUGGEST mientras el usuario todavía está escribiendo su dirección de correo electrónico, para ofrecer sugerencias de autocompletado basadas en su nombre. Para validar una dirección de correo completa, consulte API de Email — Validar una dirección de correo electrónico →
MAILSUGGEST
Solicitud
Se admiten tanto GET como POST.
{SERVER_ADDRESS} y {LICENCE_CODE} son proporcionados por DQE al crear la cuenta. Póngase en contacto con su gestor de cuenta DQE para obtenerlos.
GEThttps://{SERVER_ADDRESS}/MAILSUGGEST/?Nom={NAME}&Prenom={FIRST_NAME}&Email={EMAIL}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}
Ejemplos de código
Testa Testb, sin email parcial introducido
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/
Envíe todos los parámetros en el cuerpo de la solicitud usando Content-Type: application/x-www-form-urlencoded. La dirección del servidor permanece en la URL.
Ejemplos de código
Testa Testb, sin email parcial introducido
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))
}
Parámetros
| Parámetro | Descripción | Obl / Opc |
|---|---|---|
| Nom | Apellido introducido por el usuario. Puede dejarse vacío
|
Obligatorio |
| Prenom | Nombre introducido por el usuario. Puede dejarse vacío
|
Obligatorio |
| Parte de la dirección de correo ya introducida por el usuario. Puede dejarse vacío
|
Obligatorio | |
| Pays | Código de país ISO 3166-1 alfa-3, usado para orientar los dominios sugeridos hacia un país específico. Por defecto:
FRA
|
Opcional |
| Licence | Su clave de licencia DQE. Póngase en contacto con soporte si aún no tiene una. | Obligatorio |
Respuesta
Si tiene éxito, la API devuelve un objeto JSON que contiene las direcciones de correo sugeridas.
| Clave | Descripción | Tipo |
|---|---|---|
| Instance | Campo heredado, ya no se usa. | String |
| syntaxe |
ok o ko, según la sintaxis del correo ya introducido. |
String |
| suggest | Lista de direcciones de correo sugeridas. | Array |
Ejemplo de respuesta
Testa Testb, sin email parcial introducido
{
"Instance": "0",
"suggest": [
"ttesta@",
"testat@",
"t.testa@",
"testbtesta@",
"ttestb@",
"testatestb@",
"testa.testb@",
"testb.testa@",
"testb-testa@",
"testa-testb@",
"t-testa@",
"testa-t@"
],
"syntaxe": "ok"
}
Errores
| HTTP | Tipo de error | Respuesta |
|---|---|---|
| 400 | Falta el parámetro Licence
|
Bad Request |
| 400 | Parámetro Licence vacío |
Bad Request |
| — | Número de licencia incorrecto | Cuerpo de respuesta vacío (sin código de error) |
Probar la API
Haga clic en el botón de abajo para probar este endpoint en vivo en su navegador.
Abrir consola
Ver también
Relacionada con