API de Email — Sugerir una dirección de correo electrónico (REST)

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para obtener una lista de sugerencias de direcciones de correo electrónico basadas en el nombre, el apellido y los caracteres ya introducidos por el usuario en el campo de correo electrónico.

Documentación Restful de Email relacionada:

Solicitud GET

Endpoint

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

Reemplace los valores entre llaves por su propia información.

Parámetro Descripción Obligatorio/Opcional
FirstName Nombre introducido por el usuario. Obligatorio
LastName Apellido introducido por el usuario. Obligatorio
Email Parte de la dirección de correo ya introducida por el usuario. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Licence Código de licencia asignado a su cuenta. Obligatorio

Solicitud POST

Endpoint

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

Agregue los siguientes parámetros en el cuerpo de la solicitud usando x-www-form-urlencoded.

Parámetro Descripción Obligatorio/Opcional
FirstName Nombre introducido por el usuario. Obligatorio
LastName Apellido introducido por el usuario. Obligatorio
Email Parte de la dirección de correo ya introducida por el usuario. Obligatorio
Country Código de país ISO de 3 letras. Obligatorio
Licence Código de licencia asignado a su cuenta. Obligatorio

Respuesta

Respuesta de éxito

La respuesta JSON es un diccionario que contiene el número de resultados y un array de sugerencias de correo.

Clave Descripción Tipo
Found Número de resultados de sugerencia devueltos. INTEGER
Suggestion Array de resultados de sugerencia. ARRAY
Instance Valor personalizado devuelto tal cual en la respuesta. STRING
InputEmail Valor del correo tal como se envió en la solicitud. STRING
Syntaxe ok o ko, según la sintaxis del correo ya introducido. STRING
List Lista de direcciones de correo sugeridas. ARRAY
ListCount Número de direcciones de correo sugeridas en List. INTEGER

Ejemplo:

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

Respuesta de error

Tipo de error Tipo de respuesta
Parámetro obligatorio ausente o vacío 400 Bad Request
Licencia inválida o no autorizada 401 Unauthorized

Ejemplo (400):

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

Ejemplo (401):

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

Ver también

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0