Criação de integrações de conversas na Central de administração

Qual é o meu plano?

Suite

Professional, Enterprise ou Enterprise Plus

Observação: para poder criar integração de conversas, você precisa estar em um plano Zendesk Suite Professional ou superior. Saiba mais sobre os preços do Sunshine Conversations ou entre em contato com o departamento de vendas para obter mais informações.

As integrações de conversas ajudam as empresas a unificar mensagens de todos os canais, chatbots ou aplicativos de terceiros em uma única conversa e criar experiências interativas em todos os lugares.

Esse recurso é bidirecional entre sua empresa e o Sunshine Conversations. A integração consiste em:

• Um webhook.
• (Opcional) Um conjunto de chaves da API para interagir com a API pública com um escopo de integração. Para obter informações sobre a criação de chaves da API, consulte Uso de chaves da API de conversas.

Observação: as integrações de conversas eram conhecidas anteriormente como webhooks no painel do Sunshine Conversations.

Você pode criar integrações de conversas usando a página Integrações de Conversas na Central de administração.

Você também pode criar sua integração usando a curl ou o Postman.

Este artigo inclui as seções a seguir:

• Criação e configuração de conversas na Central de administração
• Outros métodos de integração

Criação e configuração de conversas na Central de administração

Na página Integrações de conversas, é possível:

• Criar uma nova integração
• Adicionar uma chave da API
• Visualizar, editar ou apagar uma integração

Criação de uma nova integração de conversas

Como criar uma integração de conversas na Central de administração

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida. Todas as conversas que já estavam criadas são mostradas na lista.

   Se essa é a primeira vez que está criando uma integração na Central de administração, clique em Criar integração para visualizar a página Integração de conversas.

2. Clique em Criar integração. A página Criar integração é exibida.
3. Insira um nome específico para identificar a integração.
4. Na seção Webhook, insira as informações a seguir:
   • URL do ponto de extremidade do webhook: a URL alvo. Quando ocorre um evento de gatilho, o webhook detecta o evento e envia os dados para a URL alvo. A URL alvo usa este formato: https://www.yourdomain.com/path.
   • Dados do corpo do webhook: Use as caixas de seleção para indicar se deseja incluir o esquema do usuário e as informações do cliente e do dispositivo nos dados do webhook.
   • Assinaturas do webhook: selecione os eventos sobre os quais deseja ser avisado.
5. Clique em Salvar. A janela Copiar segredo compartilhado é exibida.
6. (Opcional) Copie a ID do webhook e o segredo compartilhado. Esses são usados pelos desenvolvedores para adicionar outra camada de autenticação e não são obrigatórios.
7. Clique em Next. A página de configuração da integração é exibida. Nela, é possível adicionar uma chave da API, se necessário.

Adição de uma chave da API

Na aba Chave da API, é possível configurar a autenticação para a integração. A chave da API identifica e autentica um aplicativo ou usuário e é composta de três itens:

• A ID do aplicativo identifica sua conta do Zendesk.
• A ID da chave quando usada com a chave secreta as credenciais são usadas para autenticar os JWTs e as chamadas da API.
• A chave secreta é a senha de autenticação.

Observação: as chaves da API configuradas na página de edição de Integrações de Conversas são para integrações personalizadas. Elas são limitadas a uma integração personalizada específica e não podem modificar outras integrações. Para chaves da API a nível de aplicativo, consulte a página de autenticação do Sunshine Conversations.

Como criar e compartilhar uma chave da API

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida.
2. Clique na aba Chave da API.
3. Clique em Criar chave da API. Se você está criando a sua primeira chave, esse botão é exibido na parte inferior da página; se você já tiver criado uma chave, ele será exibido no canto superior direito.
4. Na caixa de diálogo Criar nova chave, insira um nome de identificação para a chave e clique em Avançar.
5. Na caixa de diálogo Copiar segredo compartilhado, clique em Copiar para cada ID e chave secreta para salvá-la na área de transferência e clique em Avançar. Você será redirecionado para a janela da API, onde você verá a nova chave na lista.

Se você gerar um nova chave, mas atingir o número máximo de 10, verá uma notificação pedindo que apague as chaves não utilizadas.

Como apagar uma chave não utilizada

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas.
2. Clique na aba Chave da API.
3. Passe o cursor sobre a chave que você deseja apagar, clique no menu de opções () e selecione Apagar.

Para confirmar a ação, clique em Apagar.

Visualização, edição e exclusão de uma integração

Como trabalhar com uma integração existente

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida.
2. Passe o cursor sobre a integração que você deseja atualizar, clique no ícone de Opções () e selecione uma opção:
   • View details: exibe a página de detalhes da integração, onde você pode visualizar as IDs do aplicativo, integração e webhook além de informações sobre segredos compartilhados, detalhes do webhook e chaves da API.
   • Editar: abre a página Criar integrações, na qual você pode atualizar o nome da integração e os detalhes do webhook.
   • Apagar: inicia o assistente de exclusão. Você pode cancelar e sair do assistente a qualquer momento.

Outros métodos de integração

Esses métodos estão disponíveis apenas para usuários com uma licença separada do Sunshine Conversations, mas não com a licença que vem com o Zendesk Suite Professional ou superior.

Como criar uma integração de conversas usando a curl

1. Crie uma integração usando a API Create Integration e defina type como custom.
2. Forneça os parâmetros necessários conforme especificado na API. O alvo é a URL do seu servidor e a lista de gatilhos determina quais eventos receber.

Como criar uma integração de conversas usando o Postman

1. Crie uma integração usando a API Create Integration e defina type como custom.
2. Baixe e instale o aplicativo do Postman.
3. Baixe a Postman collection do Sunshine Conversations e configure seu ambiente.
4. No Postman, selecione Smooch > Integrations > Create Integrations.
5. Forneça os parâmetros necessários conforme especificado pelo seu tipo de integração.

Para obter mais informações sobre as APIs do Sunshine Conversations, consulte Integrações.

Consulte também os guias sobre envio e recebimento de mensagens. Você irá querer configurar webhooks usando as REST APIs.