Identificar usuarios

Utiliza este punto de conexión para identificar a un usuario no identificado (solo alias, solo correo electrónico o solo número de teléfono) utilizando el ID externo proporcionado.

Cómo funciona

La llamada /users/identify combina un perfil de usuario identificado por un alias (perfil solo con alias), una dirección de correo electrónico (perfil solo con correo electrónico) o un número de teléfono (perfil solo con número de teléfono) con un perfil de usuario que tiene un external_id (perfil identificado) y, a continuación, elimina el perfil solo con alias.

Para identificar a un usuario es necesario incluir un external_id en los siguientes objetos:

• aliases_to_identify
• emails_to_identify
• phone_numbers_to_identify

Si no hay ningún usuario con ese external_id, el external_id se añade al registro del usuario con asignación de alias y se considera que el usuario está identificado. Los usuarios solo pueden tener un alias para una etiqueta específica. Si ya existe un usuario con el external_id y tiene un alias existente con la misma etiqueta que el perfil solo con alias, entonces los perfiles de usuario no se combinan.

Comportamiento de fusión

De forma predeterminada, este punto de conexión fusiona la siguiente lista de campos que se encuentran exclusivamente en el usuario anónimo con el usuario identificado.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso users.identify.

Límite de velocidad

Aplicamos un límite de velocidad compartido de 20 000 solicitudes por minuto a este punto final. Este límite de velocidad se comparte con los puntos finales /users/delete, /users/alias/new, /users/merge y /users/alias/update, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

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,
},

Parámetros de la solicitud

Puedes añadir hasta 50 alias de usuario por solicitud. Puedes asociar varios alias de usuario adicionales a un único external_id.

Identificación de usuarios mediante direcciones de correo electrónico y números de teléfono

Si se especifica una dirección de correo electrónico o un número de teléfono como identificador, también debes incluir prioritization en el identificador.

prioritization debe ser una matriz que especifique qué usuario fusionar si se encuentran varios usuarios. prioritization es una matriz ordenada, lo que significa que si más de un usuario coincide a partir de una priorización, no se produce la fusión.

Los valores permitidos para la matriz son:

• identified
• unidentified
• most_recently_updated (se refiere a dar prioridad al usuario actualizado más recientemente)
• least_recently_updated (se refiere a dar prioridad al usuario actualizado menos recientemente)

En la matriz de priorización solo puede existir una de las siguientes opciones a la vez:

• identified se refiere a dar prioridad a un usuario con un external_id
• unidentified se refiere a dar prioridad a un usuario sin un external_id

Ejemplo de solicitud

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"]
    }
  ]
}'

Distinción entre mayúsculas y minúsculas

El campo alias_name distingue entre mayúsculas y minúsculas. Una solicitud que devuelve un código de estado 201 solo confirma que la sintaxis de la solicitud era válida; no confirma que el alias haya coincidido. Si las mayúsculas y minúsculas de alias_name en tu solicitud no coinciden exactamente con el alias almacenado en el perfil de usuario, la operación fallará silenciosamente y el external_id no se asignará. Por ejemplo, si el alias almacenado es [email protected], una solicitud con [email protected] devolverá éxito pero no producirá ningún resultado.

Respuesta

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