Como criar um usuário com acesso à API

Para realizar integrações do CXM de Atendimento PipeRun com outras plataformas, é necessário que seja criado um usuário com acesso à API.

Por exemplo: utilizando um usuário do CXM de atendimento com acesso à API, é possível configurar uma automação de envio de mensagem padrão utilizando o CRM de vendas sempre que um gatilho de oportunidade for acionado, dando agilidade e economizando seu tempo gasto com execução de processos dentro da plataforma. Para saber mais, acesse este artigo.


VÍDEO TUTORIAL


TÓPICOS DO ARTIGO

  1. Como criar um usuário com acesso à API
  2. Como gerar uma chave API
  3. Como atribuir um agente para o usuário

COMO CRIAR UM USUÁRIO COM ACESSO À API


1. Acesse o painel administrativo da sua conta do CXM de atendimento. Informe o usuário e a senha e clique em "Iniciar".

Tela de login do PipeRun com campos de usuário e senha, botão Iniciar e opção de recuperação de senha

2. Clique em "Controle de acesso" (1) e, em seguida, clique em "Usuários"(2).


Painel Administrativo Piperun com menu lateral destacando opções Controle de acesso e Usuários

3. Agora, clique em "Adicionar", localizado no canto superior direito da tela.


Botão 'Adicionar' destacado em azul no canto superior direito da tela de cadastro

4. Preencha os seguintes campos:

  • Filial(preenchimento obrigatório): selecione a Filial onde a conta será registrada; 
  • Nome (preenchimento obrigatório): informe um nome para identificação do usuário da conta;
  • Login (preenchimento obrigatório): informe um nome para login na conta;
  • Senha: informe uma senha para fazer login na conta;
  • Nível de acesso (preenchimento obrigatório): dê preferência ao usuário com nível de acesso de "Supervisor" ou "Adminstrador";
  • E-mail(preenchimento obrigatório): informe um e-mail do usuário da conta;
  • WhatsApp: informe um número de WhatsApp do usuário da conta;
  • Idioma (preenchimento obrigatório): informe o idioma que será utilizado pelo usuário da conta;
  • Ativo?: defina se o usuário está habilitado para utilizar o sistema;
  • Permite acesso externo?: defina se o usuário está habilitado para utilizar o sistema fora da rede interna da filial;
  • Permite acesso à API?: defina se o usuário poderá acessar a API do sistema. Habilite esta opção.

Atenção! Usuários com acesso à API não conseguem efetuar login no sistema. Portanto, os campos "Senha", "WhatsApp" e "Permite acesso externo" não precisam ser preenchidos.

Por fim, clique em "Salvar".

Formulário de cadastro de usuário com campos obrigatórios e botão Salvar destacado em vermelho

Pronto! Seu usuário com acesso à API foi criado. Saiba no próximo passo como gerar uma chave para o seu usuário API.


GERANDO UMA CHAVE API

1. Clique em "Controle de acesso"(1) e, em seguida, clique em "Usuários"(2).

Painel Administrativo Piperun: menu de navegação lateral destacando Controle de acesso e Usuários para gerar chave API
2. Localize o usuário com acesso à API e clique no botão "Editar".

Tabela de status de usuários com destaque no botão editar de usuário com acesso à API

3. Na tela de edição do usuário, clique em "Gerar nova chave de API".

Formulário de edição de usuário com campo 'Gerar nova chave de API' destacado em vermelho


4. Uma mensagem de alerta será exibida em tela. Ao gerar uma nova chave de API a chave anterior será revogada e não poderá mais ser utilizada. Caso esteja de acordo, clique em "Sim".


Tela de confirmação para gerar nova chave de API com aviso sobre revogação da chave anterior

5. Pronto! Basta copiar o client_id e o client_secret.

Tela de confirmação de chave API gerada com sucesso, exibindo client_id e client_secret para cópia

Atenção! Certifique-se de copiar e armazenar os valores client_id e client_secret, em um ambiente seguro. A única forma de acessar essas informações será nessa janela de confirmação. Caso as informações sejam perdidas, será necessário gerar uma nova chave API.

COMO ATRIBUIR UM AGENTE AO USUÁRIO

1. No painel administrativo do CRM de Atendimento, clique em "Controle de acessos" (1) e, em seguida, em "Agentes" (2).

Painel Administrativo do Piperun CRM com menu lateral mostrando Controle de acessos e submenu Agentes destacados

2. Na lista de usuários, clique em "+ Adicionar".


Tela de gerenciamento de Agentes no Painel Administrativo com tabela de usuários e botão Adicionar destacado


3. Informe os campos para o cadastro do usuário. Os campos para preenchimento são:

Formulário de cadastro de agente com campos para usuário, turno de trabalho, nome fictício, login, ID externo e permissões

  • "Usuário": selecione o nome de usuário de API foi criado seguindo as orientações do tópico 1.
  • "Turno de trabalho": selecione na lista um turno de trabalho previamente cadastrado na sua conta;
  • "Nome fictício": informe um nome fictício para o agente;
  • "@": não é necessário preencher este campo;
  • "Ativo?": habilite esta opção;

4. A seguir, deixe habilitado todas as demais permissões conforme imagem abaixo.

Lista de permissões do sistema com 12 opções habilitadas (SIM) e uma desabilitada (NÃO), incluindo funções de atendimento, clientes, áudio, email e bloqueio

Dica: para saber mais sobre cada uma das opções de configuração acesse este artigo.

 5. Em "Filas que o agente recebe atendimento", não é necessário adicionar nenhuma fila pois o usuário de API não recebera atendimentos.

Interface de configuração 'Filas que o agente recebe atendimentos' com listas de filas disponíveis e filas do agente para transferência

6. Por fim, clique no ícone das setas para selecionar todas as filas que o agente poderá visualizar as conversas

Interface de seleção de filas com duas colunas: 'Filas disponíveis' à esquerda e 'Filas deste agente' à direita, com setas para transferir entre elas

Após preencher os campos e configurar as filas, clique em "Salvar".

Tela de configuração de filas de atendimento com opções de filtro, lista disponível e filas do agente, com botões Salvar e Restaurar

Atenção! Embora o usuário de acesso a API não possa acessar o CXM de Atendimento é necessário que ele tenha permissões para realizar ações e também permissões para acessar as filas de atendimento.

Pronto! O agente foi atribuído ao usuário de API.


Em caso de dúvidas, chame nossa equipe no chat. 😉