Breve Visão Geral

A API Segmentos permite que serviços externos criem, atualizem, recuperem e excluam segmentos do WalkMe de forma programática. Use-o para automatizar a segmentação de conteúdo, aplicar filtragem avançada no Insights e simplificar a geração de relatórios.

Por exemplo, você pode usar o Heap Análise para criar um segmento e acionar um ShoutOut com base nessa lógica de segmentação.

Tokens de acesso de autenticação

Um token de acesso é uma credencial usada por um aplicativo para acessar uma API. Ele informa ao sistema que o portador está autorizado a executar ações específicas, como passar dados de um sistema externo para o Menu WalkMe.

Criar token de acesso

1. Abra o Console do WalkMe
   
   • Centro de dados dos EUA
   • Centro de dados da UE
   • Centro de dados SAP EUA
   • Centro de dados SAP UE
   • Centro de dados FedRAMP
   • Centro de Dados do Canadá
2. Vá para a categoria Admin
3. Selecione Gerenciamento de acesso e Chaves de API
4. Selecione Criar nova chave
5. Digite um nome para a chave que indique sua finalidade
6. Ativar a API de Segmentos
7. Selecione Escrever e Ler no menu suspenso
8. Selecione Criar
9. No painel Detalhes da Chave, copie o ID do Cliente e o Segredo do Cliente

Configurando a conexão de API

Para obter seu token de autorização, consulte a referência Obter token de autorização no Hub do desenvolvedor.

Use os seguintes detalhes para configurar sua conexão:

• URL: https://api.walkme.com/accounts/connect/token
• Método: POST
• Tipo de carga útil: application/x-www-form-urlencoded
• Dados: grant_type client_credentials
• Autenticação básica: digite o ID do cliente e o Segredo do cliente copiados da página Chaves de API

O sistema gera um token de acesso depois que você envia a solicitação. Copie o token e use-o para gerenciar Segmentos.

Exemplo de solicitação de cURL

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <credenciais>' \
--data-urlencode 'grant_type=client_credentials'
# <credenciais> é a codificação base64 da chave do consumidor e do segredo do consumidor da conta do WalkMe unidos por dois pontos.

Exemplo de resposta JSON

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

Referência de endpoint

Criar segmento

Crie um novo segmento com base em uma lista estática de usuários.

• Método: POST
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• Cabeçalhos: Authorization: Bearer <Access Token>
• Parâmetros de URL: systemGuid (encontrado no Editor do WalkMe no Snippet)
• Carga / Corpo: {"id": "<external id>", "name": "<WalkMe Segment Name>", "userIds": ["user1@company.com", "user2@company.com"]}
• Limitações:
  • Máximo de 25.000 usuários por solicitação
  • Máximo de 100 caracteres por valor de ID

Atualizar segmento

Modifique usuários dentro de um segmento existente.

• Método: PUT
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
• Cabeçalhos: Authorization: Bearer <Access Token>
• Parâmetros de URL:
  • systemGuid: GUID do sistema WalkMe
  • segmentGuid: o GUID do segmento específico (deve incluir hífens, por exemplo: 12345aeb-123c-4d83-8b38-a5a456789d0a)
• Parâmetros de carga útil:
  • userIds: lista de IDs para modificar (limite de 25.000)
  • action: Especifique adicionar, remover ou substituir
• Exemplo de carga útil: {"action": "add", "userIds": ["jane.doe@walkme.com"]}

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

Obter segmentos

Recupere uma lista de segmentos existentes.

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

Excluir segmentos

Remova permanentemente um segmento.

• Método: DELETE
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}
• Cabeçalhos: Authorization: Bearer <Access Token>
• Parâmetros de URL: segmentId (o ID do segmento de destino)

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>

Notas técnicas

• Um novo segmento pode levar até 10 minutos para aparecer no Construtor de condições
• O WalkMe não exibe usuários que foram sincronizados por meio dessa integração
• Para usar seu segmento no Editor do WalkMe, abra o Construtor de condições e selecione Atributos de usuário, Segmento externo e o nome do segmento. Use apenas É ou Não é como operador e digite Verdadeiro no campo de entrada