Antes de começar
Certifique-se de que:- Sua conta usa um plano pago da YCloud. Os aplicativos personalizados não estão disponíveis no plano Free.
- Sua função pode acessar Developers > Custom apps no painel da YCloud.
- Os números de telefone do WhatsApp Business de que o aplicativo precisa já estão disponíveis em sua conta da YCloud.
- Você sabe de quais permissões de API a integração precisa.
- Você possui um endpoint HTTPS publicamente acessível caso o aplicativo precise de eventos de webhook.
Criar um aplicativo
- Faça login no painel da YCloud.
- Acesse Developers > Custom apps.
- Clique em Create app.

- Insira um App name. O nome pode conter até 64 caracteres.
- Opcional: insira uma Description de até 512 caracteres para que sua equipe saiba para que o aplicativo é usado.
- Clique em Create.

Enter an app name and, optionally, a description before selecting Create.
Atribuir números de telefone do WhatsApp
Atribua apenas os números de telefone aos quais a integração precisa ter acesso.- Abra o aplicativo e selecione Assets.
- Clique em Add phone numbers.

- Localize um número pelo nome do Gerenciador de Negócios, ID da WABA, nome da WABA ou número de telefone.
- Selecione um ou mais números de telefone do WhatsApp Business.
- Clique em Confirm.

Configurar a chave de API e as permissões
A YCloud exibe a chave de API do aplicativo em API key & permissions. As chaves de aplicativos personalizados começam comyc_ak_. Use a ação de cópia para armazenar a chave com segurança e, em seguida, adicione apenas as permissões de que a integração precisa.

- Selecione API key & permissions.
- Em API permissions, clique em Add permissions.
- Filtre por categoria ou pesquise pelo nome da permissão ou escopo.
- Selecione cada permissão necessária. Por exemplo, as permissões de contatos são divididas nos escopos de leitura, criação ou atualização e exclusão.
- Clique em Confirm.

X-API-Key e utilize-a apenas a partir de código confiável do lado do servidor. A YCloud verifica se o aplicativo está ativo e se a requisição corresponde a uma de suas permissões de API selecionadas. Quando uma API opera em um recurso do WhatsApp, a YCloud também verifica se o aplicativo pode acessar o número de telefone ou a WABA em questão.
Nem toda API da YCloud está disponível para aplicativos personalizados. Uma API que não aparece no seletor de permissões é negada para uma chave de aplicativo personalizado. As chaves de aplicativos personalizados também não podem ser combinadas com o cabeçalho X-Managed-Account-ID.
Consulte Authentication para obter orientações sobre o cabeçalho da requisição e o tratamento de credenciais.
Configurar webhooks
Configure um destino dedicado para os eventos de que este aplicativo precisa. Os webhooks do aplicativo são separados dos endpoints de webhook configurados em Developers > Webhooks.- Selecione Webhook.
- Insira seu endpoint HTTPS público em Endpoint URL e salve-o.
- Armazene o Signing secret gerado em segurança.
- Em Added events, clique em Add events.

- Filtre por categoria ou pesquise por nome de evento ou tipo de evento.
- Selecione os eventos que seu endpoint precisa receber.
- Se um evento oferecer opções de escopo de dados, escolha o escopo compatível com sua integração.
- Clique em Confirm.

2xx de sucesso prontamente. Consulte Configurar webhooks para validação de assinatura, tratamento de entrega e orientações de segurança. Consulte Payloads de eventos de Webhook para ver os esquemas de eventos.
Ativar e verificar o aplicativo
Antes de usar o aplicativo em produção:- Confirme se o aplicativo contém os números de telefone do WhatsApp Business esperados.
- Revise todas as permissões de API e remova o acesso que a integração não precisa.
- Retorne a Desenvolvedores > Aplicativos personalizados e ative o aplicativo a partir do seu menu de ações.

- Confirme se o status do aplicativo está como Ativo.
- Envie uma solicitação de teste com a chave de API do aplicativo a partir de um ambiente seguro no servidor.
- Dispare um evento selecionado e confirme se o seu endpoint o valida e processa.

