Interroger l’EUID
Cette API permet d’interroger l’EUID d’un utilisateur existant à partir d’un identifiant configuré dans le projet. Elle lit uniquement les données existantes et ne crée ni utilisateur ni nouvel EUID lorsqu’aucune correspondance n’est trouvée. Cette API applique une limite de 1 000 requêtes par minute et par projet ; au-delà, HTTP 429 avec le code d’erreur 55110 est renvoyé.
Adresse d’invocation
POST /v1/user/euid
Vérification de l’invocation
L’API REST d’EngageLab utilise l’authentification HTTP Basic :
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Afficher ce bloc de code dans la fenêtre flottante
Générez base64_auth_string avec base64(api_key:api_secret).
Exemple de requête
{
"identity_name": "user_id",
"identity_values": ["user-1", "user-2"]
}
{
"identity_name": "user_id",
"identity_values": ["user-1", "user-2"]
}
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de requête
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| identity_name | String | Oui | Nom d’un identifiant configuré dans le projet. |
| identity_values | Array |
Oui | Valeurs de l’identifiant ; 1 à 100 valeurs, 256 caractères maximum par valeur. |
Paramètres de réponse
| Champ | Type | Description |
|---|---|---|
| code | Int | 0 indique le succès, même si une valeur ne correspond à aucun utilisateur. |
| message | String | Description du résultat. |
| data | Array | Résultats dans le même ordre que les valeurs demandées. |
| identity_value | String | Valeur de l’identifiant demandé. |
| euid | Long | EUID existant ou null si aucun utilisateur ne correspond. |
| error_code | Int | 0 pour une requête réussie ; une valeur introuvable renvoie également 0. |
Exemple de réponse
{
"code": 0,
"message": "success",
"data": [
{"identity_value": "user-1", "euid": 10362473, "error_code": 0},
{"identity_value": "user-not-found", "euid": null, "error_code": 0}
]
}
{
"code": 0,
"message": "success",
"data": [
{"identity_value": "user-1", "euid": 10362473, "error_code": 0},
{"identity_value": "user-not-found", "euid": null, "error_code": 0}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d’erreur
| Code | Description |
|---|---|
| 40050 | Échec de l’authentification de l’interface. |
| 55004 | Paramètres métier invalides. |
| 55101 | Le nombre d’identifiants dépasse 100. |
| 55105 | Une valeur dépasse 256 caractères. |
| 55106 | L’identifiant n’est pas configuré dans le projet. |
| 55107 | Le nom ou la valeur de l’identifiant est vide. |
| 55110 | Limite de requêtes dépassée (1 000 requêtes maximum par minute et par projet). |
