Breve descripción general

Permite que servicios externos creen, editen, eliminen o utilicen datos de segmentos existentes de WalkMe. Esta integración permite la segmentación de contenido automatizada, el filtrado avanzado en Insights y la generación de informes optimizados.

Por ejemplo: utiliza Heap Analytics para crear un nuevo segmento y mostrar un ShoutOut basado en esa lógica de segmentación.

Tokens de acceso de autenticación

Un token de acceso es una credencial utilizada por una aplicación para acceder a una API. Le informa al sistema que el titular está autorizado a realizar acciones específicas, como pasar datos de un sistema externo al Menú de WalkMe.

Crea un token de acceso

1. Ir al Centro de administración
2. Abre la página Claves de API
3. Selecciona Crear nueva clave para
4. En el panel Crear nueva clave:
   1. Nombra la clave (indica su propósito para ayudarte a recordarla más tarde)
   2. Activa la API de Segmentos
   3. Selecciona Escribir y Leer en el menú desplegable.
   4. Selecciona Crear
5. En el panel de Detalles de la clave, copia el ID de cliente y el Secreto de cliente

Configuración de la conexión de API

Utiliza la siguiente información universalmente necesaria para configurar la aplicación de conexión:

• URL: https://api.walkme.com/accounts/connect/token
• Método: POST
• Tipo de carga útil: application/x-www-form-urlencoded
• Datos: grant_type client_credentials
• Autenticación básica: introduce el ID de cliente y el Secreto de cliente copiados del Centro de administración

Una vez que hayas añadido esta información, el sistema generará un token de acceso.

1. Copia tu token de acceso.
2. Utiliza este token para administrar segmentos

Ejemplo de solicitud de cURL

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <credenciales>' \
--data-urlencode 'grant_type=client_credentials'
# <credenciales> Es la codificación base64 de la clave de consumidor y el secreto de consumidor de la cuenta de WalkMe unidos por dos puntos.

{ "access_token": "asdjkldfsjsdfhjksfdhjkxvc32cvhjksefbnxjnweuirou8sdfg8xdfjwkjr.sv8o8vuisuhvseuksfe",
 "expires_in": 86400,
 "token_type": "Bearer",
 "scope": "segments:write segments:read"
}

Referencia de punto final

Crear segmento

Crea un nuevo segmento basado en una lista estática de usuarios.

• Método: POST
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• Encabezados: Authorization: Bearer <Access Token>
• Parámetros de URL: systemGuid (se encuentra en WalkMe Editor en el fragmento)
• Carga útil / cuerpo: {"id": "<external id>", "name": "<WalkMe Segment Name>", "userIds": ["user1@company.com", "user2@company.com"]}
• Limitaciones:
  • Máximo de 25.000 usuarios por solicitud
  • Máximo 100 caracteres por valor de ID

Actualizar segmento

Modifica usuarios dentro de un segmento existente.

• Método: PUT
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
• Encabezados: Authorization: Bearer <Access Token>
• Parámetros de URL:
  • systemGuid: GUID del sistema WalkMe
  • segmentGuid: el GUID del segmento específico (debe incluir guiones, por ejemplo: 12345aeb-123c-4d83-8b38-a5a456789d0a)
• Parámetros de carga útil:
  • userIds: lista de ID para modificar (límite de 25.000)
  • acción: especifica añadir, eliminar o anular
• Ejemplo de carga útil: {"action": "add", "userIds": ["jane.doe@walkme.com"]}

{ "action": <enum("add"|"remove"|"override")>, "userIds": [<cadena>] }

Obtener segmentos

Recupera una lista de segmentos existentes.

• Método: GET
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• Encabezados: Authorization: Bearer <Access Token>
• Parámetros de URL: systemGuid

Elimina segmentos

Elimina un segmento de forma permanente.

• Método: DELETE
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}
• Encabezados: Authorization: Bearer <Access Token>
• Parámetros de URL: segmentId (el ID del segmento de destino)

ELIMINAR <a target="_blank" data-stringify-link="https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}" delay="150" data-sk="tooltip_parent" href="https://api.walkme.com/public/v1/user/system/%7BsystemGuid%7D/segment/%7BsegmentId%7D" rel="noopener noreferrer">https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}</a>

Notas técnicas

• Se tarda hasta 10 minutos en aparecer un nuevo segmento en el Creador de condiciones del Editor
• Para utilizar tu segmento, abre el Creador de condiciones y selecciona Atributos de usuario, luego Segmento externo y luego el Nombre de tu segmento
  • Utiliza solo Es o No es como operador y escribe True en el campo de entrada
• WalkMe actualmente no muestra a los usuarios que se han sincronizado como parte de esta integración.