Please log in to continue
WalkMe stores your data in the region chosen during account setup.
We have data centers in the US and EU that follow local privacy and compliance laws. If you're not sure which region to select, check with your admin.
Permitir que serviços externos criem, editem, excluam ou usem dados de segmentos do WalkMe existentes para fins de segmentação de conteúdo, filtragem no Insights e geração de relatórios.
Por exemplo: use o Heap Analytics para criar um novo segmento e exibir um ShoutOut de acordo com a lógica de segmentação.
O que é um token de acesso?
Um token de acesso é uma credencial que pode ser usada por um aplicativo para acessar uma API. Eles informam à API que o portador do token foi autorizado a acessar uma ação específica.
O token de acesso autentica a chamada de API, dando ao aplicativo permissão para passar dados do sistema para o WalkMe Menu.
No painel Criar nova chave:
No painel Detalhes Chave:
Para obter suporte extra e o token de autorização: página do desenvolvedor
Para obter suporte adicional, página do desenvolvedor.
Agora é hora de preencher algumas informações sobre o aplicativo de conexão API.
As informações usadas abaixo são universalmente necessárias em todos os aplicativos:
Adicionar Autenticação Básica
Depois de adicionar essas informações, você receberá um token de acesso.
Agora você pode usar o token para criar, obter, atualizar ou excluir segmentos WalkMe, usando a documentação da API abaixo.
Você também pode usar os seguintes blocos de código cURL:
Exemplo de solicitação - 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"} |
Faça a chamada
| Descrição | Criar um novo segmento com base na lista estática de usuários |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Método | POST |
| Cabeçalhos | Autorização - Portador - jwt |
| Parâmetros de URL |
Você pode obter o GUID do sistema no Trecho do >Menu do Editor> Copie a chave que está entre 'https:cdn.walkme.com/users/<GUID IS HERE>/test/walkme_<....>' |
| Carga útil/Corpo | {"id": "<extneral id>", "name": "<WalkMe Segment Name - will be visible in the Editor>", "userIds": ["John@company.com", "Melissa@company.com"] }id: heap segment id >- opcional paramuserIds: Lista de IDs de usuário -
|
| Descrição | Atualizar um segmento existente | ||
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid} | ||
| Método | PUT | ||
| Cabeçalhos | uthorization - Bearer - jwt | ||
| systemGUID | systemGuid- sistema WalkMe GUID segmentGuid - GUID do segmento WalkMe**SegmentGuid precisará ser colocado no URL em seu formato de saída com um hífen como: 12345aeb-123c-4d83-8b38-a5a456789d0a |
||
| Carga útil | application/json
Parâmetros de carga útil:
exemplo de carga útil:
|
| Descrição | Obter segmentos |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Cabeçalhos | Autorização - Portador - jwt |
| Parâmetros de URL | Guia do sistema - GUID do sistema WalkMe |
Depois que um segmento é criado, o Editor levará até 10 minutos para atualizar com o novo segmento externo no Construtor de Condições.
Para segmentar o conteúdo com base no ID do usuário estar em um segmento específico criado pela API, vá para o construtor de condições e selecione: Atributos do usuário → Segmento Externo → Nome do segmento → É ou não → "verdadeiro"
Você só deve usar Is or Is not como operador e "true" no campo de entrada (outras opções não funcionarão).
| Descrição | Excluir segmentos |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| Cabeçalhos | Autorização - Portador - jwt |
| Parâmetros de URL | ID do segmento |
EXCLUIR <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>