Saltar para o conteúdo principal
O Partner Direct Link (TP Lite) é uma opção de integração para Tech Partners aprovados da YCloud. Ele fica disponível depois que sua solicitação de Tech Partner for aprovada, e você não precisa se tornar um parceiro da Meta. Crie um link de onboarding de curta duração no seu servidor. Seu cliente pode abri-lo diretamente ou por meio de um botão em seu site. Comece com o Direct Link para testar sua integração e, em seguida, use o botão do SDK se quiser que os clientes concluam o cadastro em um pop-up.

Visão geral da integração

  1. Prepare sua conta. Torne-se um YCloud Tech Partner, crie uma chave de API e configure seu receptor de webhook.
  2. Configure seu ponto de entrada. Abra Partner > Tech Partner > Partner Direct Link e defina sua marca, a URL de redirecionamento ou as origens do SDK.
  3. Crie um link. Seu servidor solicita um link de onboarding para um cliente no seu sistema.
  4. Deixe o cliente se conectar. Ele abre a página hospedada ou o pop-up do SDK e conclui a autorização da Meta.
  5. Confirme o resultado. Seu backend recebe o webhook e associa a WABA ao cliente.

Antes de começar

  1. Torne-se um YCloud Tech Partner aprovado. O Partner Direct Link ficará disponível automaticamente.
  2. Crie uma chave de API em Desenvolvedores > Chave de API.
  3. Configure seu receptor em Desenvolvedores > Webhooks e assine whatsapp.business_account.updated.
Chame a API de criação de link a partir do seu servidor. Nunca inclua sua chave de API no código do navegador ou do app móvel. Trate cada URL de onboarding como uma credencial temporária: mantenha-a fora de páginas públicas, ferramentas de analytics e logs públicos.
  1. Abra o painel da YCloud para sua conta de Tech Partner aprovada.
  2. Abra Partner > Tech Partner.
  3. Selecione a aba Partner Direct Link .
Página do Tech Partner com as abas Meta Tech Provider e Partner Direct Link

After approval, open Partner > Tech Partner and select Partner Direct Link.

A página contém Configurações básicas para sua marca e Integração para criar um link, integrar o ponto de entrada e assinar webhooks. Use Pré-visualização da página hospedada para ver a página voltada ao cliente.

Configurar sua marca e ponto de entrada

Abra Partner > Tech Partner > Partner Direct Link no painel da YCloud. Preencha as Configurações básicas: Para origens do SDK, insira o esquema exato, o domínio e a porta opcional, sem um caminho. Adicione cada subdomínio ou porta separadamente; caracteres curinga não são suportados. Use HTTPS em produção. HTTP é permitido apenas para desenvolvimento em localhost. O Direct Link funciona sem uma origem permitida do SDK; o SDK Button não.
  • WhatsApp Business Platform (WHATSAPP_BUSINESS_PLATFORM): Escolha este modo para conectar um número para envio de mensagens por APIs e pelo seu software.
  • Coexistência com o WhatsApp Business App (WHATSAPP_BUSINESS_APP): Escolha este modo para um número qualificado do Business App existente quando o cliente quiser continuar usando o app e adicionar mensagens por API no mesmo número.
Os idiomas com suporte são en_US (inglês), zh_CN (chinês simplificado), es_ES (espanhol), pt_BR (português do Brasil), id_ID (indonésio) e ru_RU (russo). Os valores diferenciam maiúsculas de minúsculas. Outros valores retornam HTTP 400. Exemplo de resposta:
expiresAt é o horário de expiração como um timestamp Unix em milissegundos. O tempo de vida padrão do link é de duas horas. Cada link conecta um cliente a uma WABA. Antes de a inscrição ser concluída, o cliente pode atualizar, tentar novamente ou abrir o link em outro navegador enquanto ele permanecer válido. Após a vinculação bem-sucedida, o link não poderá vincular outra WABA. Crie um novo link quando o cliente precisar alterar ou adicionar uma WABA. Adicione um botão de conexão ao aplicativo do seu cliente. Quando o cliente clicar nele, solicite um link de integração ao seu servidor e navegue até onboardingUrl ou abra-o em uma nova janela. Você também pode enviá-lo de forma privada ao cliente desejado por meio de um canal seguro e individual. O cliente abre a página hospedada e clica em Continuar com a Meta. Ele usa uma conta do Facebook com permissão para gerenciar a empresa e seleciona ou cria sua empresa, WABA e número de telefone na Meta. A YCloud conclui a vinculação e exibe o resultado.
Integração por Direct Link com um placeholder de URL de integração e uma prévia da página de cadastro do cliente

Direct Link integration and the hosted page preview. This example has no generated onboarding link.

Se você configurou uma URL de redirecionamento, a inscrição bem-sucedida redireciona para lá com status=connected anexado como um parâmetro de consulta. Use isso para atualizar a página voltada ao cliente; use o webhook abaixo para confirmar a vinculação no seu backend.

Opção 2: Botão do SDK

Adicione a origem da sua página a Allowed SDK origins e, em seguida, carregue o SDK. O código do seu navegador chama seu próprio backend para obter o link. A rota /api/ycloud/onboarding-link abaixo é um exemplo de rota que você implementa no seu servidor.
onStatus(result) relata o estado da inscrição: onError(error) significa que o SDK não conseguiu abrir a inscrição. Seu code pode ser POPUP_BLOCKED ou INVALID_ONBOARDING_URL. onClose(event) é disparado apenas quando o cliente fecha a janela antes de um resultado final, com reason: "USER_CLOSED". Esses callbacks atualizam o seu frontend. Use o webhook no servidor como o resultado final da vinculação.

Confirmar a vinculação com um webhook

Etapa de integração do Partner Direct Link mostrando o evento de webhook whatsapp.business_account.updated

Subscribe to whatsapp.business_account.updated in Developers > Webhooks to receive the binding result.

A YCloud envia whatsapp.business_account.updated para o seu receptor de webhook configurado após o sucesso da vinculação. O trecho a seguir mostra os campos que sua integração utiliza:
Quando updateEvent for PARTNER_ADDED, processe a WABA como recém-adicionada. Faça a correspondência de partnerCustomerId com o seu cliente e salve o id da WABA. Um valor de paymentMethodAttached igual a true significa que a vinculação de crédito foi bem-sucedida; false significa que ela ainda não foi concluída. Desduplique entregas usando o evento id e retorne HTTP 2xx após o recebimento bem-sucedido. Consulte Webhooks para obter instruções sobre a configuração do receptor.