Identifier les utilisateurs

Utilisez cet endpoint pour identifier un utilisateur non identifié (alias uniquement, e-mail uniquement ou numéro de téléphone uniquement) à l’aide de l’ID externe fourni.

Fonctionnement

L’appel à /users/identify combine un profil utilisateur identifié par un alias (profil alias seul), une adresse e-mail (profil e-mail seul) ou un numéro de téléphone (profil numéro de téléphone seul) avec un profil utilisateur possédant un external_id (profil identifié), puis supprime le profil alias seul.

L’identification d’un utilisateur nécessite qu’une adresse external_id soit incluse dans les objets suivants :

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

S’il n’existe aucun utilisateur avec cet identifiantexternal_id, celui-ciexternal_idest ajouté à l’enregistrement de l’utilisateur aliasé, et l’utilisateur est considéré comme identifié. Les utilisateurs ne peuvent disposer que d’un seul alias pour une étiquette spécifique. Si un utilisateur existe déjà avec leexternal_id et dispose d’un alias existant avec le même libellé d’alias que le profil alias uniquement, les profils utilisateur ne sont pas fusionnés.

Comportement de fusion

Par défaut, cet endpoint fusionne la liste suivante de champs trouvés exclusivement sur l’utilisateur anonyme avec l’utilisateur identifié.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation users.identify.

Limite de débit

Nous appliquons une limite de débit partagée de 20 000 requêtes par minute à cet endpoint. Cette limitation du débit est partagée avec les endpoints /users/delete, /users/alias/new, /users/merge et /users/alias/update, comme documenté dans Limites de débit de l’API.

Corps de la demande

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
{
   "aliases_to_identify" : (required, array of alias to identify objects),
   "emails_to_identify": (optional, array of alias to identify objects) User emails to identify,
   "phone_numbers_to_identify": (optional, array of alias to identify objects) User phone numbers to identify,
},

Paramètres de demande

Vous pouvez ajouter jusqu’à 50 alias utilisateur par demande. Vous pouvez associer plusieurs alias utilisateur supplémentaires à un seul external_id.

Identification des utilisateurs par leurs adresses e-mail et leurs numéros de téléphone

Si une adresse e-mail ou un numéro de téléphone est spécifié comme identifiant, vous devez également inclure prioritization dans l’identifiant.

Ilprioritizationdoit s’agir d’un tableau spécifiant quel utilisateur fusionner si plusieurs utilisateurs sont trouvés.prioritizationIl s’agit d’un tableau ordonné, ce qui signifie que si plusieurs utilisateurs correspondent à une priorité, la fusion n’a pas lieu.

Les valeurs autorisées pour le tableau sont les suivantes :

• identified
• unidentified
• most_recently_updated (Priorité à l’utilisateur le plus récemment mis à jour)
• least_recently_updated (Priorité à l’utilisateur le moins récemment mis à jour)

Une seule des options suivantes peut exister à la fois dans le tableau de priorisation :

• identified Il s’agit de donner la priorité à un utilisateur ayant une external_id
• unidentified Il s’agit de donner la priorité à un utilisateur qui n’a pas de external_id

Exemple de demande

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://rest.iad-01.braze.com/users/identify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "aliases_to_identify": [
    {
      "external_id": "external_identifier",
      "user_alias": {
          "alias_name": "example_alias",
          "alias_label": "example_label"
      }
    }
  ],
  "emails_to_identify": [
    {
      "external_id": "external_identifier_2",
      "email": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

Réponse

1
2
3
4
{
    "aliases_processed": 1,
    "message": "success"
}