Obtain EUID

EUID est l'identifiant unique de la plateforme EngageLab MA. Vous pouvez utiliser l'API suivante pour récupérer l'EUID à partir de l'identifiant utilisateur.

Adresse d'invocation

POST /v1/user/register

Vérification de l'invocation

L'API REST d'EngageLab utilise l'authentification HTTP Basic comme méthode de vérification. Ajoutez Authorization dans l'en-tête HTTP :

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Afficher ce bloc de code dans la fenêtre flottante

Le base64_auth_string est généré selon l'algorithme suivant : base64(api_key:api_secret).

Le nom de l'en-tête est "Authorization", et la valeur est la paire "nom d'utilisateur:mot de passe" encodée en base64 (séparée par un deux-points).
Pour l'API MA, le nom d'utilisateur correspond à l'APIKey, et le mot de passe correspond à l'APISecret. Veuillez configurer une source de données de type API pour obtenir l'APIKey et l'APISecret.

Exemple de requête

En-tête de la requête

> POST /v1/user/register > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Afficher ce bloc de code dans la fenêtre flottante

Corps de la requête

{ "identity_name":"user_id", "identity_values": [ "18012345678", "18012345678" ] }

              
              {
    "identity_name":"user_id",
    "identity_values": [
        "18012345678",
        "18012345678"
    ]
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Champ	Type	Obligatoire	Description
identity_name	String	Oui	Nom de l'identifiant utilisateur, prend en charge des valeurs telles que user_id, anonymous_id ou registration_id
identity_values	list	Oui	Valeurs des identifiants utilisateur, jusqu'à 100 valeurs prises en charge, chaque valeur ne dépassant pas 256 caractères

Paramètres de retour

Champ	Type	Obligatoire	Description
code	Int	Oui	Indique si l'appel à l'API a réussi. 0 signifie succès ou succès partiel, toute autre valeur indique un échec
message	String	Oui	Description du résultat de l'appel à l'API, expliquant le code de retour
data	Array	Non	Liste des EUID correspondant aux identifiants utilisateur retournés
identity_value	String	Oui	La valeur de l'identifiant utilisateur
euid	Long	Oui	L'identifiant utilisateur unique correspondant à EngageLab MA
error_code	Int	Oui	Indique si la récupération de l'EUID a réussi. 0 représente le succès, toute autre valeur indique un échec

Tous réussis

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", "euid": 10362473, "error_code": 0 }, { "identity_value": "18012340000", "euid": 10362474, "error_code": 0 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",
            "euid": 10362473,
            "error_code": 0
        },
        {
            "identity_value": "18012340000",
            "euid": 10362474,
            "error_code": 0
        }
    ]
}

Afficher ce bloc de code dans la fenêtre flottante

Tous échoués

{ "code": 55101, "message": "Limite du nombre d'identifiants utilisateur dépassée" }

              
              {
    "code": 55101,
    "message": "Limite du nombre d'identifiants utilisateur dépassée"
}

Afficher ce bloc de code dans la fenêtre flottante

Succès partiel

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", "euid": null, "error_code": -1 }, { "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000", "euid": null, "error_code": 55105 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",
            "euid": null,
            "error_code": -1
        },
        {
            "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
            "euid": null,
            "error_code": 55105
        }
    ]
}

Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code	Description	Explication détaillée
40050	Échec de l'authentification de l'interface.	Vérifiez si l'ID du projet et la clé secrète du projet sont corrects.
40007	EUID est vide.	Veuillez vérifier la valeur de l'EUID.
50031	ID du projet invalide.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects.
50034	ID du projet inexistant.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects et si le projet a été supprimé.
50074	Source de données API inexistante.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects et si la source de données API a été supprimée.
55004	Paramètres métier invalides.	Veuillez vérifier si les champs des paramètres de la requête sont corrects.
55101	Le nombre d'identifiants utilisateur dépasse la limite.	Vérifiez si le nombre de valeurs d'identification utilisateur dépasse 100.
55102	Il existe des noms d'attributs utilisateur invalides.	Vérifiez si le nom de l'attribut respecte les exigences de nommage, et s'il n'est pas vide/n'utilise pas de caractères réservés/ne dépasse pas la limite de longueur.
55103	Les valeurs des attributs utilisateur ne peuvent pas être vides.	Vérifiez si la valeur de l'attribut utilisateur dans le corps de la requête est vide.
55105	La valeur de l'identifiant utilisateur ne peut pas dépasser 256 caractères.	Vérifiez si la valeur de l'identification utilisateur dépasse 256 caractères.
55106	Le nom de l'identifiant utilisateur n'est pas dans la plage prise en charge.	Vérifiez si le nom de l'identifiant utilisateur est user_id, anonymous_id ou registration_id.
55107	La valeur de l'identifiant utilisateur est vide.	Vérifiez si la valeur de l'identification utilisateur dans le corps de la requête est vide.
55108	EUID invalide.	Veuillez vérifier la valeur de l'EUID.
-1	Erreur interne du serveur.	Veuillez contacter le support technique EngageLab.