Para usar o Canal do Facebook, você deve criar um aplicativo do Facebook no portal do desenvolvedor. Você pode encontrar mais detalhes sobre como criar aplicativos do Facebook aqui.
Pré-requisitos
- Uma conta válida no Facebook.
- Uma página válida no Facebook.
Registrar um Aplicativo no Facebook
- Acesse o portal de desenvolvedores do Facebook e clique no botão “Create App” (Criar Aplicativo).
- Selecione a opção “Other” (Outro).
- Para o tipo de aplicativo, escolha “Business” (Empresa).
- Insira detalhes básicos como o nome do aplicativo e e-mail.
Após registrar seu Aplicativo do Facebook, você precisará obter o App Id (ID do Aplicativo) e o App Secret (Chave Secreta do Aplicativo). Esses valores estarão disponíveis nas configurações do aplicativo e serão necessários ao configurar as variáveis de ambiente do AirysChat.
Configurando as Variáveis de Ambiente no AirysChat
Configure as seguintes variáveis de ambiente do AirysChat com os valores que você obteve durante a configuração do aplicativo do Facebook. O FB_VERIFY_TOKEN deve ser uma string única e segura que você fornece ao configurar o aplicativo do Facebook. Gere uma string aleatória e defina-a como o FB_VERIFY_TOKEN. O Facebook incluirá essa string em todas as requisições de verificação.
Reinicie o servidor do AirysChat após atualizar as variáveis de ambiente.
FB_VERIFY_TOKEN=
FB_APP_SECRET=
FB_APP_ID=
Configurar o Login do Facebook
- Adicione o produto Facebook Login através do painel do aplicativo do Facebook.
- Habilite
Web OAuth Login, Login with Javascript SDK e adicione seu domínio self-hosted na entrada Allowed Domains for the JavaScript SDK.
Configurar o Aplicativo do Facebook
- Nas configurações do aplicativo, adicione o
domínio de instalação do AirysChat como o domínio do seu aplicativo.
- Na seção de produtos na página de configurações do seu aplicativo, adicione “Messenger”.
- Vá para as configurações do Messenger e configure a URL de callback (URL de retorno).
- Forneça a URL de Callback como
{your_airyschat_installation_url}/bot e o Token de verificação como FB_VERIFY_TOKEN da sua variável de ambiente.
- Acesse o AirysChat e crie uma caixa de entrada do Messenger. Escolha uma página para a qual a sua conta de desenvolvedor do Facebook tenha acesso de administrador. Por favor, consulte este guia para mais detalhes sobre como criar uma caixa de entrada do Messenger no AirysChat.
Testando o canal do Facebook
Até que o aplicativo seja aprovado para produção, o Facebook não enviará as novas mensagens da sua página para o AirysChat.
Para testar as alterações até que o aplicativo seja aprovado para produção, siga os passos abaixo:
- Acesse a seção do messenger na página de configurações do seu aplicativo, no portal de desenvolvedores do Facebook.
- Clique em
Add or remove pages (Adicionar ou remover páginas) e conecte a página que você escolheu ao criar a caixa de entrada do Messenger no AirysChat.
- Após conectar as páginas, clique em
Add subscriptions (Adicionar assinaturas) a partir da página conectada.
- Inscreva-se nos seguintes campos e salve a assinatura.
messages
messaging_postbacks
message_deliveries
message_reads
message_echoes
- Envie uma mensagem para a página conectada a partir da sua conta do Facebook e ela deve aparecer no AirysChat agora.
Entrando em produção
Antes que você possa começar a usar o seu aplicativo do Facebook em produção, você precisará que ele seja verificado pelo Facebook. Consulte a documentação sobre como ter seu aplicativo verificado.
Obtenha acesso avançado às permissões necessárias mencionadas abaixo para o seu aplicativo do Facebook:
pages_messaging (Para enviar mensagens em nome da página)
pages_show_list (Para listar as páginas a serem conectadas no airyschat)
pages_manage_metadata (Assinar webhooks em nome da página)
business_management
pages_read_engagement (Ler dados de seguidores (incluindo nome, PSID) e perfil)
Business Asset User Profile Access (Para acessar a foto do perfil e o nome das pessoas que contatam a página)
Certifique-se de que a versão da assinatura do seu aplicativo do Facebook seja 17.0. Nós atualizamos a assinatura do FB para a versão mais recente, então altere a versão de assinatura de permissão nas opções de webhooks do aplicativo do facebook.
Desenvolvendo ou Testando a Integração do Facebook na sua máquina
Instale o ngrok na sua máquina. Isso será necessário já que a API do Facebook Messenger se comunicará apenas via https.
Configure o ngrok para rotear para a porta do seu servidor Rails.
Vá para a página de desenvolvedores do Facebook e navegue até as configurações do seu aplicativo. Nas configurações do aplicativo, adicione localhost como domínio do seu aplicativo.
Na página de configurações do Messenger, configure a url de callback com o seguinte valor.
Atualize o token de verificação nas suas variáveis de ambiente do AirysChat.
Você também terá que adicionar uma página do Facebook à sua seção Access Tokens na sua página de configurações do Messenger.
Reinicie o servidor local do AirysChat. Sua configuração do AirysChat estará pronta para receber mensagens do Facebook.
Versão da API do Facebook
Nós suportamos a API do Facebook versão v13.0 em diante, a qual você pode atualizar nas configurações avançadas do aplicativo do facebook.
Testar sua Configuração local
- Após terminar a configuração acima, crie uma caixa de entrada do Facebook após fazer login na sua Instalação do AirysChat.
- Envie uma mensagem para sua página do Facebook.
- Aguarde e confirme as requisições de entrada para o endpoint
/bot na sua tela do ngrok.
