Integrações

Visão geral

As integrações personalizadas são usadas por clientes do Workplace para o desenvolvimento interno (ou desenvolvimento sob medida para uso exclusivo de um único cliente do Workplace) a fim de integrar as próprias ferramentas ou ecossistema de software ao Workplace.

Nesta seção, aprenderemos a criar e a configurar uma integração personalizada no Workplace.

Como criar uma integração

Para criar uma integração, entre no Workplace como um administrador que tenha a permissão para alterar as configurações da empresa e configurar integrações. Quanto tiver entrado, você poderá concluir as etapas a seguir para criar uma integração:

Depois de ter criado a integração, você poderá configurá-la.

Configuração básica

Na seção Integrações do Painel Administrativo, clique no nome da integração a ser configurada. Estes são os campos que você poderá encontrar na tela de detalhes da integração.

• Detalhes da integração: você pode modificar o Nome, logotipo e descrição da integração, ver o ID do aplicativo e a chave secreta do aplicativo e criar ou redefinir o Token de acesso da sua integração.
  O token de acesso é necessário para enviar qualquer solicitação da API. Com ele, o Workplace pode verificar e validar se as solicitações estão sendo enviadas pela integração. Recomendamos salvar o token de acesso em um lugar seguro. Ele pode ser usado para realizar ações importantes no Workplace, como criar ou desativar contas de usuários (contanto que a integração tenha as permissões correspondentes).
• Visibilidade: você pode ativar ou desativar a integração. Se desativada, a integração não poderá fazer solicitações de API.
  Você também pode ativar ou desativar a visibilidade dela, fazendo com que ela apareça na lista de bots disponíveis no Workplace.
• Última solicitação da API: você pode visualizar o último dia em que a integração fez uma solicitação de API e o número de solicitações feitas nos últimos sete dias.
• Excluir integração: você pode excluir a integração. Essa ação não é reversível e excluirá a integração e todo o conteúdo associado a ela.

Permissões

Na tela de configuração da integração, há uma seção chamada Permissões. Nela, você pode escolher a quais permissões a sua integração precisará de acesso. Abaixo há uma lista de permissões.

Para saber mais sobre as permissões de integrações personalizadas, acesse a documentação do desenvolvedor.

Webhooks

Outra seção disponível para configurar para cada integração é a de Webhooks. Com os Webhooks, você poderá assinar eventos específicos e receber atualizações em tempo real. Quando houver uma alteração no Workplace, uma solicitação HTTPS POST será enviada à URL de retorno de chamada correspondente a cada aplicativo de integração personalizada que assinou o tópico de webhook em questão.

Um exemplo de um webhook pode ser receber uma atualização na URL de retorno de chamada quando um comentário for feito em uma publicação.

Tópicos
Os Webhooks são divididos em tópicos. É possível definir uma URL de retorno de chamada diferente por tópico. Mais informações sobre os tópicos e as assinaturas disponíveis podem ser encontradas na documentação do desenvolvedor.

Como assinar um webhook
Mais informações sobre como assinar e acionar um webhook podem ser encontradas na documentação do desenvolvedor.

Segurança

Para uma integração, a última seção da configuração é a de Segurança. Você pode ativar dois tipos de configurações aqui:

• Lista de permissão de IP do servidor, onde é possível adicionar endereços IP a uma lista de permissões para receber apenas chamadas de API que vêm desses endereços.
• Exigir prova da chave secreta do aplicativo, onde é possível ativar uma camada extra de segurança que exigirá que detalhes da chave secreta do aplicativo sejam inseridos ao fazer uma chamada da API.