Integração

A integração às Lojas é uma etapa necessária para permitir que os vendedores sejam integrados ao Comércio da Meta. Com a integração, é possível garantir que os produtos do vendedor estejam atualizados, as informações da encomenda estejam devidamente sincronizadas (além de serem fáceis de conciliar em uma base trimestral ou anual) e as informações bancárias e de pagamento estejam configuradas de modo correto para pagamentos e relatórios em tempo hábil.

Requisitos

É necessário fazer a integração com a Extensão do Facebook para Empresas (FBE) para atender aos critérios de qualidade de integração das nossas Lojas, permitindo que os vendedores façam o seguinte:

• Descubram facilmente a integração da Meta na plataforma
• Conectem a conta de terceiros aos ativos da Meta, como o Gerenciador de Negócios, catálogos existentes (quando aplicável), Pixels existentes (quando aplicável), Páginas e identificadores do Instagram
• Configurem e editem as configurações da Loja no local, como configurações de devolução, informações legais, informações da conta bancária e informações fiscais
• Vinculem ativos adicionais à loja, como Páginas e identificadores do Instagram
• Editem as configurações
• Façam remoções

Antes de começar

1. Faça a integração da sua empresa verificada à FBE.
2. Adicione a FBE ao seu app e obtenha acesso ao Painel de Desenvolvedores da FBE. Consulte este diagrama para saber mais sobre o fluxo da FBE para o Comércio.
3. Siga estas etapas de configuração da FBE e, depois, envie a sua integração para a análise de integração da FBE. Isso inclui a ativação da experiência de gerenciamento de recursos da FBE na sua plataforma, para que as empresas possam mudar os recursos ou até desinstalar as configurações da FBE.

Requisito 1: integrar com a Extensão do Facebook para Empresas

A Extensão do Facebook para Empresas (FBE) é uma interface em pop-up de propriedade da Meta que fica em sites de terceiros como um plugin, simplificando o processo de integração geral com a Meta. A FBE permite que as empresas configurem de forma fácil o Pixel da Meta, o catálogo e as Lojas. Ela também ajuda as empresas a conectarem produtos e serviços com os canais do Facebook e do Instagram na sua plataforma. Depois disso, você pode ajudá-las a usar um grande conjunto de recursos avançados.

Resumindo, a separação de responsabilidades em uma integração baseada na FBE funciona da seguinte forma:

• Propriedade da Meta: interface, autenticação, conexão e uma superfície [(FBE Management view)](Visualização de gerenciamento de recursos da FBE) para ver os ativos conectados, gerenciar as funcionalidades instaladas e o status das integrações de comércio
• Propriedade do Parceiro: configuração de pixel, upload de inventário para o catálogo do Facebook por meio de API

Depois da configuração, qualquer uma das suas empresas poderá iniciar um fluxo de integração da FBE, seja com ativos existentes, com a opção de criar novos ou com uma combinação de ambos.

Etapa 1: adicionar pontos de entrada da FBE ao seu app

Crie pontos de entrada para a FBE onde o usuário seleciona, gerencia ou cria ativos (por exemplo, empresas, catálogo, lojas, pixel etc.). Esses pontos de entrada podem assumir uma destas formas:

• Login da empresa (também conhecido como Login do Facebook): permite que as empresas iniciem a conexão da sua plataforma usando um botão no seu site.
• Aplicativos de Negócios: permite que as empresas iniciem a conexão de uma superfície da Meta. Para ativar esse fluxo e ter o app listado nos Aplicativos de Negócios da Meta, é necessário fornecer uma interface de autenticação do usuário personalizada no seu site. Essa interface deve permitir que o usuário selecione a empresa e, depois, o redirecione de volta ao fluxo da Meta com a informação selecionada.

Exemplo

https://facebook.com/dialog/oauth?
client_id=<FB_APP_ID>
&display=page
&redirect_uri="https://partner-site.com/redirectlanding"
&response_type=token
&scope=manage_business_extension
//   additionally use catalog_management or ads_management
//   &scope=manage_business_extension,catalog_management,ads_management
&extras={
  "setup": {
    "external_business_id": "foo-123",
    "timezone": "America/Los_Angeles",
    "currency": "USD",
    "domain": "https://example-shop.partner-site.com/",
    "channel": "ECOMMERCE",
    "business_vertical": "ECOMMERCE"
  },
  "business_config": {
    "business": {
      "name": "Foo Business"
    },
    "catalog_feed_scheduled": {
      "enabled": true,
      "feed_url": "https://partner-site.com/feed-url"
    },
    "page_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business",
      "below_button_text": "Powered by FBE Partner"
    },
    "ig_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    },
    "messenger_menu": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    }
  },
  "repeat": false
}

Dependendo da configuração escolhida, você pode obter o token de acesso da empresa para as etapas posteriores de várias formas:

• Login da empresa: como ocorre com o Login do Facebook normal, o fim do fluxo retorna um access_token, que você usa para obter mais ativos (por exemplo, identificação do pixel, da página e da empresa no Instagram).
• Aplicativos de Negócios: por meio de Webhooks.

Etapa 2: configurar Webhooks FBE_install

Webhooks são necessários para todos os parceiros que querem ser listados na App Store. Se você não planeja ter o seu app na App Store, pode ignorar esta seção ou visitá-la mais tarde. A Meta aciona eventos de webhook sempre que uma das suas empresas instala, modifica ou desinstala a FBE. Sempre que um evento de webhook é recebido, espera-se que o app consuma o evento e compreenda quais ativos a empresa modificou, adicionou ou removeu da conexão com o seu app. O comportamento do app deve ser atualizado com base nos ativos conectados mais atuais. Recomendamos que você implemente e teste a sua inscrição no nosso webhook.

Para configurar um webhook:

1. Crie um ponto de extremidade em um servidor seguro que possa processar solicitações da Meta adequadamente.
2. No Painel de Aplicativos, configure a descrição dos webhooks da FBE:
1. Na seção FBE > na aba Webhooks, digite a URL de retorno de chamada do app.
2. Insira um token de verificação e, em seguida, valide o ponto de extremidade.

Após a configuração, o webhook fbe_install é inscrito automaticamente.

Para etapas mais detalhadas, consulte Webhook.

Notificações

Após receber uma notificação de webhook de uma instalação, você precisa fazer o seguinte:

1. Armazenar o token de acesso (e o tipo dele) e registrar os ativos aos quais o app recebeu acesso.
2. Ativar um conjunto de recursos com base nos ativos que foram concedidos.
3. Se um ativo necessário para um recurso específico estiver ausente, desative somente esse recurso. Por exemplo, se o app tiver recebido acesso a um catálogo, mas não a um pixel, implemente apenas o recurso com tecnologia de catálogo, não o de pixel.
4. Informar o usuário com uma atualização sobre como o app está se comportando com base em quais ativos ele pode acessar.

Veja o que você precisa fazer ao receber uma atualização sobre uma instalação existente:

1. Atualizar o token de acesso e registrar os ativos que foram concedidos a você.
2. Atualizar o conjunto de recursos para os quais o seu app será habilitado para o vendedor com base nos ativos que foram concedidos à plataforma.
3. Informar o usuário com uma atualização sobre como o app está se comportando com base em quais ativos ele pode acessar.

Ao receber uma notificação de desinstalação, você precisa fazer o seguinte:

1. Desativar os recursos que o app implementa para o vendedor.
2. Informar o vendedor sobre a mudança na configuração.

Etapa 3: buscar detalhes do ativo com o token retornado

É possível obter informações sobre as empresas conectadas à sua plataforma pela FBE por meio de um dos métodos a seguir (ou ambos):

• Webhook: necessário para todos os parceiros que querem ser listados na App Store. Com uma configuração de webhook, os detalhes da integração ou edição das empresas por meio da FBE serão recebidos pela carga de webhook da configuração de webhook da Etapa 2.
• Ponto de extremidade da API de Instalações da FBE: recomendado para empresas de hospedagem própria. Para todas as empresas que tiverem instalado a FBE, você pode consultar as informações básicas de instalação usando o ponto de extremidade fbe_installs. É possível chamar o ponto de extremidade da API de Instalações da FBE usando o token de acesso e a identificação externa da empresa para ter informações detalhadas sobre a configuração.

Exemplo: chamada de API de Instalações da FBE

curl -i -X GET \   "https://graph.facebook.com/<version>/fbe_business/fbe_installs?fbe_external_business_id=<external business id>&access_token=<access token sanitized>"

Etapa 4: buscar o token de usuário do sistema

Após a instalação da FBE, a extensão gera um usuário do sistema para o funcionário no Gerenciador de Negócios do cliente. Esse usuário do sistema não fica mais visível no Gerenciador de Negócios, mas existe no backend. A nomenclatura para esse novo usuário do sistema segue o esquema {App Name} System User (FBE).

Para isso, faça a seguinte chamada à API:

curl -X POST \
  -F 'app_id={app_id}' \
  -F 'scope=ads_management,catalog_management,manage_business_extension' \ 
  -F 'access_token={user_access_token}' \
  -F 'fbe_external_business_id={fbe_external_business_id}' \ 
https://graph.facebook.com/<API_VERSION>/<client_business_manager_id>/access_token

Para o campo scope, use a permissão manage_business_extension. Dependendo do caso de uso (consulte a Etapa 5), é provável que as permissões ads_management, catalog_management, pages_read_engagement, business_management, instagram_basic e manage_business_extension também sejam necessárias.

• Se o app precisar ler e gerenciar a conta de anúncios de uma empresa, solicite a permissão ads_management. Com essa permissão, você pode criar campanhas de anúncios, buscar métricas de anúncios, criar ferramentas de gerenciamento de anúncios e muito mais.
• Se o app precisar criar, ler, atualizar ou excluir catálogos de produtos empresariais dos quais uma empresa é administradora, solicite a permissão catalog_management. Recomendamos essa permissão para todos os apps. Isso permite que o app crie soluções de gerenciamento de inventário e anúncios dinâmicos relacionados ao comércio.

Etapa 5: configurar a visualização de gerenciamento

Para permitir que as empresas configurem ainda mais recursos (além dos que foram especificados na instalação), direcione as empresas para a nossa Visualização de gerenciamento de recursos da FBE na sua plataforma. Você pode usar a URL ou o SDK de JavaScript para adicionar um ponto de entrada a fim de iniciar a Visualização de gerenciamento da FBE. Ambos os métodos precisam exibir um botão que, ao clicar, inicia a janela de Visualização de gerenciamento da FBE.

Etapa 6: adicionar um ponto de entrada para desinstalação da FBE

Sua plataforma precisa adicionar um ponto de entrada (como um botão) para que as empresas desinstalem a FBE. Recomendamos fazer isso com uma solicitação DELETE ao ponto de extremidade adequado.

Exemplo: chamada para o nosso ponto de extremidade de exclusão

curl -X DELETE \
"https://graph.facebook.com/v<API_VERSION>/fbe_business/fbe_installs?fbe_external_business_id=<FBE_EXTERNAL_BUSINESS_ID>&access_token=<ACCESS_TOKEN>"

Se tiver implementado um webhook fbe_install, você receberá eventos quando o usuário desinstalar a FBE.

Saiba mais

• Extensão do Facebook para Empresas (FBE)
• Etapas de configuração da FBE
• Painel do Desenvolvedor da Extensão do Facebook para Empresas
• Desinstalar a FBE
• Webhooks