API de segmentos (Beta)
Breve descripción general
Permite que los servicios externos creen, editen, eliminen o utilicen datos de segmentos existentes de WalkMe con el propósito de segmentar el contenido, filtrar Insights y generar informes.
Por ejemplo: utiliza Heap Analytics para crear un nuevo segmento y mostrar un ShoutOut de acuerdo con la lógica de segmentación.
Autenticación y creación de un token de acceso.
¿Qué es un token de acceso?
Un token de acceso es una credencial que puede ser utilizada por una aplicación para acceder a una API. Informan a la API que el portador del token ha sido autorizado a acceder a una acción en particular.
El token de acceso autentica la llamada a la API, lo que permite a la aplicación pasar datos de su sistema a Workstation.
Crea un token de acceso
- Ir al Centro de administración
- Navega hasta la pestaña Claves API: https://admin.walkme.com/account-api-keys
- Haz clic en Crear nueva clave
Desde el panel Crear nueva clave:
- Nombra la clave
- Consejo: indica el propósito de la clave en el nombre para ayudarte a recordarla más tarde.
- Activa la API de Segmentos
- Selecciona Escribir y Leer en el menú desplegable.
- Haz clic en Crear
Desde el panel Detalles clave:
- Copia el ID del cliente y la Clave secreta.
Token de autenticación
Para obtener soporte adicional y obtener el token de autorización: página del desarrollador.
Añade información a la aplicación de conexión API.
Para obtener soporte adicional, la página de desarrollador.
Ahora es el momento de introducir algunos datos sobre la aplicación de conexión a API.
La información que se utiliza a continuación es universalmente necesaria en todas las aplicaciones:
- URL = https://api.walkme.com/accounts/connect/token
- Tipo de carga útil = application/x-www-form-urlencoded.
- Data = grant_type → client_credentials
Añade autenticación básica
- ID del cliente | Secreto del cliente (copiado del Centro de administración)
- Ejemplo
0o234234234UqD5d7 | JVnD346346346345asfgasgbPt_4T7h2_
- Ejemplo
Una vez que hayas añadido esta información, se te dará un token de acceso.
- Copia tu token de acceso.
Ahora puedes utilizar el token para crear, obtener, actualizar o eliminar segmentos de WalkMe, utilizando la documentación de API a continuación.
También puedes utilizar los siguientes bloques de código cURL:
Ejemplo de solicitud: cURL
--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Basic <credentials>' \--data-urlencode 'grant_type=client_credentials'# <credentials> is the base64 encoding of the consumer key and consumer secrect of the WalkMe account joined by a colon. |
{ "access_token": "asdjkldfsjsdfhjksfdhjkxvc32cvhjhjksefbnxjnweuirou8sdfg8xdfjwkjr.sv8o8vuisuhvseuksfe", "expires_in": 86400, "token_type": "Bearer", "scope": "segments:write segments:read"} |
Haz la llamada
Crear segmento
| Descripción | Crea un nuevo segmento basado en una lista estática de usuarios. |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Método | POST |
| Encabezados | Autorización - Bearer - jwt |
| Parámetros de URL |
Puedes obtener el GUID del sistema del Snippet del Editor. Copia la clave que está entre 'https:cdn.walkme.com/users/<GUID IS HERE>/test/walkme_<....>' |
| Carga útil / Cuerpo | {"id": "<extneral id>", "name": "Nombre del segmento de WalkMe - será visible en el Editor", "userIds": ["John@company.com", "Melissa@company.com"] }id: ID del segmento heap - paramuserIds opcional: lista de ID de usuario -
|
Actualizar segmento
| Descripción | Actualiza un segmento existente | ||
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid} | ||
| Método | PUT | ||
| Encabezados | Autorización - Bearer - jwt | ||
| systemGUID | systemGuid - GUID del sistema WalkMe segmentGuid - GUID del segmento de WalkMe **SegmentGuid deberá colocarse en la URL en su formato de salida con un guion: 12345aeb-123c-4d83-8b38-a5a456789d0a | ||
| Carga útil | application/json
parámetros de carga útil:
ejemplo de carga útil:
|
Obtener segmentos
| Descripción | Obtener segmentos |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Encabezados | Autorización - Bearer - jwt |
| Parámetros de URL | GUID del sistema: el GUID del sistema de WalkMe. |
Una vez que se crea un segmento, el Editor tardará hasta 10 minutos en actualizarse con el nuevo segmento externo en el generador de condiciones.
Para segmentar el contenido en función de si el ID del usuario está en un segmento específico creado por la API, ve al generador de condiciones y selecciona: Atributos del usuario → Segmento externo → Nombre del segmento → Es o no → "true".
Solo debes utilizar Es o No es como operador, y "true" en el campo de entrada (las otras opciones no funcionarán).
Elimina segmentos
| Descripción | Elimina segmentos |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Encabezados | Autorización - Bearer - jwt |
| Parámetros de URL | ID del segmento |
DELETE <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>