TABELA DE CONTEÚDOS
- Prefácio
- Passo 1: Criar um App
- Passo 2: Instalar o App
- Passo 3: Testar o App
- Passo 4: Publicar o App
- O que vem a seguir
- Como utilizar o Bloco de Autenticação
- Configurar Variáveis Globais dentro do Bloco de Autenticação
- Como usar o Payload
- Como usar Fontes
- Como utilizar a Orientação
- Como tornar os Campos Opcionais
- Como Usar Gatilhos
- Como usar Campos do Sistema
- Resumo
Prefácio
O App do Manychat é uma maneira de conectar as ferramentas de terceiros e o Manychat.
Isso requer compreensão de:
- Autenticação de API
- Chamadas de API
- JSON
Se você tiver experiência de desenvolvimento, este artigo e exemplos fornecidos podem ser usados como um guia abrangente para construir seu primeiro App do Manychat.
Para clientes sem experiência em desenvolvimento, o Manychat atualmente não fornece suporte educacional, mas você pode achar os seguintes recursos úteis:
Vamos rever como funciona o App do Manychat. O App consiste em nome, descrição e JSON.
Nome e Descrição do App são auto-explicativas - por favor, consulte a imagem anexada abaixo. A imagem mostra como o Nome do App é importado para a Lista de Ações após a instalação:
JSON é um conceito central para Apps do Manychat, pois especifica os detalhes da sua integração. Então o Manychat observa essa especificação para descobrir do que seu aplicativo é capaz e transforma JSON em elementos de interface nativos para usuários finais.
Um App típico contém:
-
Autenticação
- Se uma plataforma que você conecta o Manychat requer autorização, configure este bloco e especifique ele como"auth": null
-
Ações
- Cada App deve conter pelo menos 1 ação -
Fontes
- Isso é opcional. Você pode configurar uma fonte para variáveis usadas em sua ação/ações, se necessário.
Aqui está uma breve visão geral de como o Manychat identifica títulos e descrição da Ação:
Vamos nos aprofundar nos detalhes e ver como desenvolver seu próprio App.
Abaixo você pode encontrar um processo passo a passo que revela o processo de criação do aplicativo (com exemplos de código aberto e cenários de utilização). A especificação técnica está disponível aqui.
Passo 1: Criar um App
Vamos criar um aplicativo de exemplo simples que gera um número aleatório dentro de um determinado intervalo.
Verifique estes pré-requisitos:
- https://csrng.net/documentation/csrng-lite/ será usado como uma API
- Esperamos que o usuário final especifique o intervalo usando os campos do bot
Siga estes passos para criar um app:
- Vá em Aplicativos e clique no botão '+ Novo Aplicativo'
- Preencha estes campos:
Nome do Aplicativo: App de Número Aleatório
Descrição do Aplicativo: Melhor App de geração de números Aleatório
-
Aplicativo JSON (consulte o Projeto Glitch, se você quiser testar este app - use app_for_copy.json, como não contém comentários, o atual campo JSON do App aceita apenas JSON sem comentários):
Clique no botão "Criar Aplicativo"
Aqui estão alguns exemplos de como esses dados são importados pelo Manychat:
Formulários JSON → Formulários de Interface do Usuário:
Os dados capturados através do formulário são usados na requisição:
Mapeamento:
Passo 2: Instalar o App
- Clique no botão 'Instalar' sob o menu de três pontos
- Escolha a conta que você deseja aplicar e termine a instalação.
Passo 3: Testar o App
- Vá para o Construtor de Fluxo e selecione seu aplicativo na lista de ações
- Configurar a Ação
- Construa um novo fluxo como neste exemplo:
-
Visualize seu fluxo:
Passo 4: Publicar o App
Depois que seu pedido estiver pronto, você poderá revisá-lo e publicá-lo.
Quando você clica no botão 'Publicar', você inicia o processo de revisão conduzido pela equipe Manychat para tornar seu app público. Nós revisaremos a versão mais recente do seu app e inspecionaremos o App JSON para tomar uma decisão de aprovar ou recusar seu app.
- Se o seu aplicativo for aprovado para uma versão pública:
- Nós iremos excluir o aviso da sua página do app;
- Atribuir um número de versão ao seu aplicativo;
- Proteger esta versão de quaisquer alterações (acidentais ou intencionais) que sejam feitas para a versão 'dev' do seu app.
- Se o aplicativo for recusado:
- Nós forneceremos feedback e reiniciaremos o processo de revisão assim que todas as alterações necessárias forem implementadas e você clicar no botão 'Republicar'.
Se seu app for público, você pode listá-lo no Manychat App Store. É opcional, para mais detalhes por favor contacte devprogram@manychat.com
O que vem a seguir
Passamos por 4 passos para entender os conceitos básicos por trás da criação de aplicativos simples. Estes conceitos são os mesmo, não importa o que você criar: geradores de números aleatórios ou aplicativos de sincronização de dados para seu CRM. Para o próximo passo, recomendamos verificar nossos artigos avançados de "como fazer" abaixo. Eles irão apresentá-lo à criação de autorização dentro do aplicativo, substituindo valores codificados por fontes de dados estáticas e dinâmicas, adicionando seções de orientação em seu aplicativo. Todos esses recursos tornam seu aplicativo mais funcional e fácil de usar e, portanto, mais competitivo dentro do ambiente do Manychat.
Como utilizar o Bloco de Autenticação
A API do número aleatório não requer a chave de API, mas muitas outras APIs exigem.
Para criar uma conexão com essas APIs, você pode definir um bloco de autenticação
.
Pré-requisitos (vamos utilizar Taste Dive como exemplo):
- Crie uma conta aqui: https://tastedive.com/account/api_access
- Veja a documentação da API aqui: https://tastedive.com/read/api
Vamos tentar criar um aplicativo que requer uma chave de API e, em seguida, usá-lo como um parâmetro consulta:
Aqui está o exemplo completo do código:
Configurar Variáveis Globais dentro do Bloco de Autenticação
O Bloco de Autenticação também pode ser usado para configurar variáveis globais, como nomes de domínio, URLs de base, etc.
Você pode incluir quantos parâmetros
você precisar. Todos os dados inseridos pelos seus usuários serão salvos e disponíveis para reutilização em ações.
Aqui está um exemplo para API do ActiveCampaign:
"params": [ { "name": "base", "title": "Por favor, insira sua URL base do seu ActiveCampaign" }, { "name": "token", "title": "Por favor, insira seu token do seu ActiveCampaign" } ]
Então sua URL de solicitação de ação pode vir como https://[[base]]/api/3/
Isso poupará tempo aos seus usuários: não é necessário um formulário de ação adicional, dados reutilizáveis podem ser solicitados uma vez.
Como usar Payload (Carga útil)
Alguns endpoints (pontos de extremidade) de API requerem carga útil.
Para fazer o JSON funcionar para estes casos, você pode adicionar payload {}
como mostrado abaixo. Os valores do payload podem ser passados através de: [[]]
.
Neste caso, criamos um registro no Pipedrive. API endpoint requer carga útil com nome e e-mail. Quando o usuário final configura a ação, eles escolhem campos personalizados para nome e e-mail. Então o Manychat dispara a ação adicionando ao payload específico para cada valor de contato associado aos campos personalizados.
Aqui está o link Glitch, sinta-se à vontade para utilizar este projeto como exemplo:
Em alguns casos, não há necessidade de passar valores dinâmicos para o payload. Para que possa ficar como no exemplo:
Cada vez que uma ação está sendo processada, passaremos a mesma carga útil para a URL especificada.
Como usar o comando Sources
enum:static
Para random-number-app-v1
nós usamos o campo Min e Max fornecido pelo usuário através de campos personalizados.
Se quisermos fornecer nossos próprios valores, podemos usar o conceito de soucers
.
Consulte o exemplo Glitch e verifique comentários para os blocos forms
e sources
:
Veja como o Manychat opera com estes dados:
enum:rpc
Para similar-to-music-app
nós usamos o campo personalizado para parâmetro q
.
Utilizando enum:rpc
podemos fornecer a lista de músicos e bandas a partir dessa API. Veja este projeto Glitch para entender como adicionar a enum:rpc
ao seu Aplicativo:
Aqui está um exemplo de um código implementado:
Como utilizar a Orientação
Em alguns casos, a configuração da ação do aplicativo pode exigir orientação passo a passo. Se a descrição da ação não é suficiente para comunicar todos os detalhes necessários, você pode adicionar o campo
de orientação ao bloco de ação
.
Este é um exemplo de orientação em três etapas, para quebras de linha, você pode usar \n
(que é opcional)
Para os usuários do seu aplicativo, ele será exibido como mostrado abaixo:
Como tornar os Campos Opcionais
Às vezes, campos de ação não são obrigatórios ou podem ser preenchidos com valores padrão. Para facilitar a configuração, permitimos que os campos sejam pré-configurados com um novo parâmetro chamado default
.
Você, como desenvolvedor de aplicativos, pode especificar o valor padrão para um determinado campo. Isto tornará o campo opcional. Até que seus usuários especifiquem o seu próprio valor, você receberá o valor padrão toda vez que essa ação executar.
Veja como fica no exemplo abaixo:
Usuários do app podem ignorar este campo:
Como Usar Gatilhos
Os gatilhos permitem que você inicie fluxos quando um evento ocorre em um aplicativo externo.
Exemplos de tais eventos:
- contato cria um pedido ou paga por algo fora do Manychat;
- contatos são marcados no seu CRM;
- um evento agendado está acontecendo.
Se você deseja enviar fluxos quando esses eventos acontecem, os gatilhos estão à sua disposição.
Do ponto de vista do desenvolvedor, há alguns passos para fazer os gatilhos funcionarem:
- Especifique os gatilhos no App JSON (mais detalhes estão disponíveis aqui)
"triggers": [ { "name": "gatilho_tag_adicionada", "title": "Tag adicionada", "description": "Tag \"Negocio Fechado\" é adicionada no X CRM" } ]
- Envie um Hook no seguinte endpoint https://manychat.com/apps/wh, adicione o cabeçalho de autorização com a Chave de App toda vez que o evento ocorrer. As cargas úteis (Payloads) devem estar no seguinte formato:
curl -H "Authorization: Bearer <token>" \ -H "Content-type: application/json" \ -X POST \ -d '{"version": 1, "subscriber_id": <sub_id>, "trigger_name": <trigger>}' \ https://manychat.com/apps/wh
Como obter uma Chave do Aplicativo
Quando um cliente instala seu app, o Manychat notifica-os de que este aplicativo possui gatilhos e solicita que eles forneçam a Chave do App ao desenvolvedor do aplicativo.
Nós encorajamos você a se comunicar claramente com seus clientes da maneira como deseja obter a Chave do Aplicativo (embora a maneira habitual seja uma página especial para configurar integrações externas)
Gatilhos com contexto
Você pode enriquecer seu gatilho com contexto externo. Vamos verificar a diferença:
Gatilho simples |
Gatilho com contexto |
Pedido criado |
Pedido criado, o total do pedido é R$107,00 |
Contato é marcado como "lead" |
Contato é marcado como "lead", probabilidade de negócio é 90% |
Aqui está um exemplo JSON de como especificar o gatilho com um contexto externo.
No context
você pode fornecer quantas variáveis quiser. Todas essas variáveis podem ser usadas no construtor de fluxo para mais automações inteligentes.
"triggers": [ { "name": "gatilho_tag_adicionada", "title": "Tag adicionada", "context": [ { "name": "probabilidade_negocio", "type": "number", "title": "Probabilidade de Negócio" } ], "description": "Tag Negócio é adicionada no CRM" } ]
Aqui está o fluxo com gatilho + contexto. Você pode usar este contexto como uma condição, como parte do nó de conteúdo e fazer suas automações inteligentes, personalizadas.
curl -H "Authorization: Bearer <token>" \ -H "Accept: application/json" \ -X POST \ -d '{"version": 1, "subscriber_id": <sub_id>, "trigger_name": <trigger>, "context": { deal_probability: 90}}' \ https://manychat.com/apps/wh
Como usar Campos do Sistema
Para fácil acesso aos campos do sistema, você pode especificá-los usando chaves {{ }}. Todos os dados serão capturados automaticamente.
Aqui está um aplicativo de exemplo mostrando como capturar dados de campos do sistema sem criar formulários.
Resumo
- Explore esta documentação e projetos Glitch para entender como fazer App JSON para diferentes objetivos
- Clique em 'Remix para Editar' para criar o seu próprio aplicativo usando os nossos exemplos
- Copie e cole JSON em Aplicativos do Manychat
- Instale seu aplicativo para obter mais resultados com sua própria integração
- Compartilhe seu aplicativo com clientes para obter reconhecimento