Para interagir com a API Workvivo, um token Bearer deve ser incluído no cabeçalho de todas as solicitações. Este artigo irá guiá-lo através do processo de:
- Criando um aplicativo no Workvivo
- Adicionando as permissões/escopos necessários
- Gerando o token do portador
Dispositivo(s): Desktop
Funções/Permissões: Desenvolvedor
Disponibilidade: acesso à API habilitado mediante solicitação do Suporte
Observe o seguinte:
- Para utilizar a API do Workvivo, você deve primeiro entrar em contato com o suporte para solicitar acesso à API.
-
O Workvivo exige que qualquer usuário que interaja com nossa API receba primeiro a função de desenvolvedor. Esta tarefa pode ser executada pelo administrador da sua conta após a concessão do acesso à API. Consulte (Concedendo funções no Workvivo).
Depois que a função de desenvolvedor for concedida, o usuário terá acesso a uma opção adicional no painel de administração: “Chaves de API e configurações de JWT”. Esta configuração fornece acesso ao usuário para criar um aplicativo, adicionar/remover escopos de integração e gerar um token de portador seguindo as etapas abaixo.
1. Abra a administração e clique em “Chaves de API e configurações JWT”
2. “Clique” em Adicionar novo aplicativo
3. Conceda ao seu aplicativo as permissões/escopos necessários e nomeie-o. Este é um bom momento para revisar a documentação da API e identificar as permissões necessárias para cada endpoint. Por exemplo, para interagir com a API do Teams, você precisará aplicar todas as permissões de leitura/gravação necessárias do Teams.
Caso não tenha certeza de quais permissões são necessárias neste momento, não se preocupe, é possível fazer atualizações mais tarde, quando o aplicativo estiver no ar.
4. Agora que o aplicativo foi criado, clique em “Gerenciar chaves”.
5. “Clique” em Adicionar nova chave - Depois que a nova chave for nomeada, o token do portador será preenchido.
Salve o token em um local seguro, pois ele não poderá ser recuperado após o fechamento da janela. Se, a qualquer momento, o token do portador for comprometido, exclua-o imediatamente e crie uma nova chave.
Informações adicionais
- Para referência - documentação do desenvolvedor Workvivo
- Um lembrete de que o acesso à API não está habilitado para todas as contas Workvivo, portanto, solicite acesso ao Suporte.