Breve descripción general

La API de Segmentos permite a los servicios externos crear, actualizar, recuperar y eliminar segmentos de WalkMe mediante programación. Utilízalo para automatizar la segmentación de contenido, aplicar filtrados avanzados en Insights y optimizar la generación de informes.

Por ejemplo, puedes utilizar Heap Analytics para crear un segmento y activar 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. Abre la consola de WalkMe:
   
   • Centro de datos de EE. UU.
   • Centro de datos de la UE
   • Centro de datos SAP de Estados Unidos
   • Centro de datos SAP de UE
   • Centro de datos FedRAMP
   • Centro de datos de Canadá
2. Ve a la categoría Administrador
3. Selecciona Gestión de acceso y luego Claves de API
4. Selecciona Crear nueva clave
5. Escribe un nombre para la clave que indique su propósito
6. Activa la API de Segmentos
7. Selecciona Escribir y Leer en el menú desplegable.
8. Selecciona Crear
9. En el panel de Detalles de la clave, copia el ID de cliente y el Secreto de cliente

Configuración de la conexión API

Para obtener tu token de autorización, consulta la referencia Obtener token de autorización en el Hub de desarrollador.

Utiliza los siguientes detalles para configurar la 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 del
• Autenticación básica: escribe el ID de cliente y el Secreto de cliente copiados de la página Claves de API

El sistema genera un token de acceso después de que envíes la solicitud. Copia el token y utilízalo 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 'Autorización: Básica <credenciales del>' \
--data-urlencode 'grant_type=client_credentials'
# <credenciales del> es la codificación base64 de la clave del consumidor y el secreto del consumidor de la cuenta de WalkMe unidos a dos puntos.

Ejemplo de respuesta JSON

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

Referencia del 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"]} del
• Limitaciones:
  • Máximo 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: ELIMINAR
• 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/ del{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

• Un nuevo segmento puede tardar hasta 10 minutos en aparecer en el Creador de condiciones del
• WalkMe no muestra a los usuarios que se han sincronizado a través de esta integración del
• Para utilizar tu segmento en el Editor de WalkMe, 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