Autenticação de Apps de Negócios


Apps de Negócios, disponíveis nas superfícies do Facebook, são o destino de pequenas empresas que querem descobrir e se conectar a apps de negócios de terceiros para configurar facilmente as ferramentas comerciais por um custo baixo de tecnologia a fim de crescer e atingir as metas de negócios.


Diferentemente do Login de empresa, já que o fluxo dos Apps de Negócios é iniciado a partir das nossas superfícies, há uma etapa adicional que requer que o usuário entre na sua plataforma usando um navegador pop-up para autenticar e selecionar a empresa a ser conectada (identificada por um external_business_id definido por você). Se a autenticação for bem-sucedida, o usuário será redirecionado de volta ao fluxo para concluir a integração.

Se você quiser exibir o seu app em nossa superfície de Apps de Negócios, será necessário criar uma URL de autenticação, um ponto de extremidade de Webhook, bem como configurá-los e validá-los no Painel do desenvolvedor.

Todos os apps devem se inscrever para a análise de integração. Após a aprovação da sua integração com a FBE, o seu app ficará disponível para usuários públicos.

Observação: o Login de empresa pode ser usado como uma alternativa de autenticação dos Apps de Negócios. Consulte a documentação sobre como usar o Login de empresa.

Implementação da URL de autenticação

Os Apps de Negócios iniciam um fluxo análogo ao Login de empresa a partir da superfície de uma Página do Facebook, do Instagram e do Facebook Business Suite. Para habilitar esse fluxo e disponibilizar o app, é preciso fornecer uma interface para autenticação personalizada que permita que o usuário selecione a empresa no seu site e a redirecione de volta para o fluxo do Facebook, Instagram ou Facebook Business Suite.

Como funciona

  1. Forneça um ponto de extremidade de URL personalizado (URL de autenticação) que carregue o fluxo de autenticação da sua plataforma.
    • A URL de autenticação precisa levar o usuário (empresário) até um fluxo de login na plataforma.
    • Ofereça uma opção para criar uma nova conta na plataforma ("cadastre-se"). Após o cadastro, o usuário retornará ao Facebook para finalizar o processo de conexão da conta.
    • Caso você dê suporte a várias empresas por conta na plataforma, após um login bem-sucedido, a URL de autenticação exibirá uma interface para que o usuário possa selecionar a empresa que ele quer associar aos ativos do Facebook.
    Exemplo – URL de autenticação
    https://yourwebsite.com/fbe-auth
  2. O Facebook carrega a URL de autenticação fornecida no fluxo de integração e anexa um parâmetro de consulta redirect_uri ao final (que pode incluir parâmetros adicionais de consulta):
    https://yourwebsite.com/fbe-auth?redirect_uri=<an_encoded_redirect_uri_with_query_params>
    Exemplo – Um URI de redirecionamento codificado que pode ser anexado ao parâmetro de consulta redirect_uri:
    https://www.facebook.com/local/dev/transaction_tool_selector/redirect?app_id=<int_value>&app_name=<string_value>&page_id=<int_value>
    No final dessa etapa, o Facebook carrega a URL de autenticação com o parâmetro de consulta codificado redirect_uri que pode ter esta aparência:
    https://yourwebsite.com/fbe-auth?redirect_uri=https%3A%2F%2Fwww.facebook.com%2Flocal%2Fdev%2Ftransaction_tool_selector%2Fredirect%3Fapp_id%3D123%26app_name%3DSample%26page_id%3D456

    Observação importante: para garantir que você não compartilhe dados de usuários com terceiros, faça o redirecionamento ao redirect_uri somente se ele corresponder à expressão regular a seguir.

    https?:\/\/(www\.|m\.|l\.|web\.|business\.)?(\d{4,5}\.od\.)?(business\.)?(facebook|instagram|whatsapp)\.com(\/.*)?
  3. Depois que o usuário conclui o login/cadastro e seleciona uma empresa na sua plataforma (se aplicável), ele deve ser redirecionado à URL a partir de redirect_uri após anexar a ele um objeto extras codificado como o parâmetro de consulta (igual ao Login de empresas) com business_config e setup definidos (dependendo das configurações de integração que você quer implementar):
    https://www.facebook.com/local/dev/transaction_tool_selector/redirect?app_id=<int_value>&app_name=<string_value>&page_id=<int_value>&extras=<an_encoded_json_string>

Observação: ao oferecer a opção de criar uma nova conta na plataforma na URL de autenticação, verifique se a interface renderizada 1) é compatível com dispositivos móveis e/ou 2) abre com altura/largura suficiente para renderizar corretamente o fluxo de cadastro do seu parceiro (dimensões mínimas sugeridas: 600 x 600 px).

Autenticação de iframe

Para permitir uma experiência de usuário integrada nos Apps de Negócios e facilitar a criação de novas contas na sua plataforma, habilite a URL de autenticação em um iframe na superfície do Facebook. Consulte as diretrizes de implementação e especificações pós-mensagem na documentação sobre iframes.

Implementação de webhooks

Os Webhooks permitem que você receba notificações HTTP em tempo real de mudanças em objetos específicos no gráfico social do Facebook. Para a FBE, isso significa que depois que o usuário instalar ou desinstalar a FBE usando o seu app (por exemplo, via Apps de Negócios), você receberá os detalhes dessa ação via Webhooks.

Crie um ponto de extremidade em um servidor seguro que possa processar solicitações do Facebook. Isso é obrigatório para todos os parceiros de plataforma que querem disponibilizar os seus apps em Apps de Negócios. Consulte o guia de implementação de webhooks para obter detalhes sobre como criar esse ponto de extremidade.

Configuração e validação de webhooks

Assim que o seu ponto de extremidade de webhooks estiver pronto, faça o seguinte para configurá-lo e validá-lo:

  1. Use o cartão Webhooks na seção Configuração da Extensão do Facebook para Empresas no Painel de Aplicativos para validar o ponto de extremidade e assinar o webhook fbe_install. Consulte o guia de implementação de webhooks para saber mais.
  2. Quando o produto Webhooks estiver configurado corretamente, o círculo no canto superior direito do cartão ficará verde com um visto.

Configuração e validação via Painel do desenvolvedor

O Painel do desenvolvedor da Extensão do Facebook para Empresas é um produto que você encontra no Painel de Aplicativos do desenvolvedor. Assim que os seus apps receberem o recurso da FBE, use o Painel do desenvolvedor para configurar e validar a sua URL de autenticação, ponto de extremidade de Webhook e para adicionar detalhes sobre o que o seu app oferece a uma empresa.

Configuração e validação da URL de autenticação

Assim que a sua URL de autenticação estiver pronta, para configurá-la e validá-la você deverá:

  1. No painel do app, acesse o Painel do Desenvolvedor da FBE. Observação: se você ainda não o configurou, siga estas instruções para adicioná-lo.
  2. Clique na aba Configuração e procure o cartão Superfície de Aplicativos de negócio.
  3. Marque a caixa de seleção Exibir meu aplicativo na superfície de Aplicativos de negócios.
  4. Na entrada URL de autenticação, insira a sua URL de autenticação.
  5. Clique no botão Testar autenticação.
    • Uma janela pop-up será aberta e carregará a sua URL para imitar como o Facebook a usará em superfícies de Apps de Negócios.
    • Prossiga com a seleção de login e empresa (se aplicável).
    • Após o redirecionamento, a janela pop-up fechará. Se houver algum erro na sua implementação (por exemplo, valores inválidos em extras), ele aparecerá na parte inferior desse cartão, assim você saberá o que precisa ser corrigido. O recurso Testar autenticação validará apenas a entrada em redirect_uri, e não instalará de fato a FBE.
  6. Assim que as etapas de implementação e a configuração de extras forem implementadas conforme o esperado, essa etapa será marcada como válida (marca de seleção verde no canto superior direito do cartão). Isso permitirá a realização de um teste completo desse fluxo de integração (instalação da FBE) diretamente do Facebook (consulte a seção abaixo).

Teste completo

Depois de configurar e a validar a URL de autenticação e o ponto de extremidade de webhooks no Painel do desenvolvedor, realize um teste completo do fluxo de integração, com o seu app, antes da publicação. Isso pode ser feito diretamente no Facebook Business Suite ou na superfície da Página do Facebook da seguinte forma:

No Facebook Business Suite

  1. Acesse o Facebook Business Suite.
  2. Na barra lateral esquerda, clique em Todas as ferramentas e depois em Apps de negócios.
  3. Todos os apps disponíveis estarão listados ali. O seu estará sob a categoria que você selecionou como Vertical(is) na aba Configuração do Painel do desenvolvedor.
  4. Seu app terá a etiqueta Apenas para teste — Não público. Isso significa que ele está disponível para teste apenas para os usuários que têm uma função no seu app, mas para usuários públicos ainda não.
  5. Clique em Conectar e comece a testar a experiência com a sua URL de autenticação:
    • O fluxo de integração realiza a instalação real da FBE e disparará as notificações de webhooks.

Na superfície da Página do Facebook

  1. Acesse uma Página do Facebook à qual você tenha acesso de administrador.
  2. Na barra lateral esquerda da sua Página do Facebook, clique em Aplicativos de negócios.
  3. Todos os apps disponíveis estarão listados ali. O seu estará sob a categoria que você selecionou como Vertical(is) na aba Configuração do Painel do desenvolvedor.
  4. Seu app terá a etiqueta Apenas para teste — Não público. Isso significa que ele está disponível para teste apenas para os usuários que têm uma função no seu app, mas para usuários públicos ainda não.
  5. Clique em Conectar e comece a testar a experiência com a sua URL de autenticação:
    • O fluxo de integração realiza a instalação real da FBE e disparará as notificações de webhooks.