Obtain EUID
El EUID es el identificador único de la plataforma EngageLab MA. Se puede utilizar la siguiente API para recuperar el EUID en función del identificador de usuario.
Dirección de invocación
POST /v1/user/register
Verificación de invocación
La API REST de EngageLab utiliza HTTP Basic Authentication como método de verificación. Añadir Authorization a la cabecera HTTP:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Este bloque de código se muestra en una ventana flotante
El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(api_key:api_secret).
- El nombre de la cabecera es "Authorization" y el valor es el par "nombre_de_usuario:contraseña" codificado en base64 (separado por dos puntos).
- Para la API de MA, el nombre de usuario corresponde a la APIKey y la contraseña corresponde al APISecret. Se debe configurar una fuente de datos de tipo API para obtener la APIKey y el API Secret.
Ejemplo de solicitud
Cabecera de solicitud
> POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
Este bloque de código se muestra en una ventana flotante
Cuerpo de solicitud
{
"identity_name":"user_id", // User identifier name
"identity_values": [
"18012345678", // User identifier value
"18012345678"
]
}
{
"identity_name":"user_id", // User identifier name
"identity_values": [
"18012345678", // User identifier value
"18012345678"
]
}
Este bloque de código se muestra en una ventana flotante
Parámetros de solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| identity_name | String | Sí | Nombre del identificador de usuario; admite valores como user_id, anonymous_id o registration_id |
| identity_values | Lista | Sí | Valores del identificador de usuario; admite hasta 100 valores, y cada valor no puede superar 256 caracteres |
Parámetros de respuesta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| code | Int | Sí | Indica si la llamada a la API se ha realizado correctamente. 0 indica éxito o éxito parcial, y otros valores indican un fallo |
| message | String | Sí | Descripción del resultado de la llamada a la API, que explica el código de retorno |
| data | Array | No | Una lista de EUID correspondientes a los identificadores de usuario devueltos |
| identity_value | String | Sí | El valor del identificador de usuario |
| euid | Long | Sí | El ID único de usuario correspondiente a EngageLab MA |
| error_code | Int | Sí | Indica si la recuperación del EUID se ha realizado correctamente. 0 indica éxito y otros valores indican un fallo |
Éxito total
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // User identifier value
"euid": 10362473, // Generated EUID, null if the acquisition fails
"error_code": 0 // Corresponding error code, 0 for success, and not empty for failure, such as 40006
},
{
"identity_value": "18012340000",
"euid": 10362474,
"error_code": 0
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // User identifier value
"euid": 10362473, // Generated EUID, null if the acquisition fails
"error_code": 0 // Corresponding error code, 0 for success, and not empty for failure, such as 40006
},
{
"identity_value": "18012340000",
"euid": 10362474,
"error_code": 0
}
]
}
Este bloque de código se muestra en una ventana flotante
Fallo total
{
"code": 55101,
"message": "Exceeded the limit of user identifiers"
}
{
"code": 55101,
"message": "Exceeded the limit of user identifiers"
}
Este bloque de código se muestra en una ventana flotante
Éxito parcial
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // User identifier value
"euid": null, // null for failure
"error_code": -1 // Corresponding error code, 0 for success, and not empty for failure
},
{
"identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
"euid": null,
"error_code": 55105
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // User identifier value
"euid": null, // null for failure
"error_code": -1 // Corresponding error code, 0 for success, and not empty for failure
},
{
"identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
"euid": null,
"error_code": 55105
}
]
}
Este bloque de código se muestra en una ventana flotante
Código de error
| Código | Descripción | Explicación detallada |
|---|---|---|
| 40050 | Fallo de autenticación de la interfaz. | Confirmar si el ID del proyecto y la clave secreta del proyecto son correctos. |
| 40007 | El EUID está vacío. | Comprobar el valor de EUID. |
| 50031 | El ID del proyecto no es válido. | Comprobar si la APIKey y el APISecret son correctos. |
| 50034 | El ID del proyecto no existe. | Comprobar si la APIKey y el APISecret son correctos y si el proyecto se ha eliminado. |
| 50074 | La fuente de datos de API no existe. | Comprobar si la APIKey y el APISecret son correctos y si la fuente de datos de API se ha eliminado. |
| 55004 | Los parámetros de negocio no son válidos. | Comprobar si los campos de los parámetros de la solicitud son correctos. |
| 55101 | El número de identificadores de usuario supera el límite. | Confirmar si el número de valores de identificación de usuario supera 100. |
| 55102 | Hay nombres de atributos de usuario no válidos. | Confirmar si el nombre del atributo cumple los requisitos de nomenclatura y si está vacío/usa caracteres reservados/supera el límite de longitud. |
| 55103 | Los valores de los atributos de usuario no pueden estar vacíos. | Confirmar si el valor del atributo de usuario en el cuerpo de la solicitud está vacío. |
| 55105 | El valor del identificador de usuario no puede superar 256 caracteres. | Confirmar si el valor del identificador de usuario supera 256 caracteres. |
| 55106 | El nombre del identificador de usuario no está dentro del rango admitido. | Confirmar si el nombre del identificador de usuario es user_id, anonymous_id o registration_id. |
| 55107 | El valor del identificador de usuario está vacío. | Confirmar si el valor del identificador de usuario en el cuerpo de la solicitud está vacío. |
| 55108 | EUID no válido. | Comprobar el valor de EUID. |
| -1 | Error interno del servidor. | Ponerse en contacto con el soporte técnico de EngageLab. |

