Suporte ao Cliente
Português
Como Instalar o YCloud Developer Kit e Criar uma Integração com a API do WhatsApp no Codex
Quanto trabalho é necessário para iniciar uma integração YCloud no Codex?
O YCloud Developer Kit traz habilidades de integração específicas da YCloud para o Codex.
Para demonstrar como funciona, este artigo utiliza um fluxo de trabalho focado em confirmação de pedido no WhatsApp com dados simulados.
Você instalará e verificará o Kit, então usará um único prompt para planejar a integração, implementá-la localmente e executar testes simulados.
Para capacidades suportadas, orientações de segurança e considerações de produção, leia YCloud Developer Kit: Crie e Teste Integrações da API do WhatsApp com o Codex.
Como Instalar o YCloud Developer Kit no Codex
Passo 1: Abra o YCloud Developer Kit
Selecione Instalar ou Experimentar agorae confirme que o Kit está habilitado no ambiente Codex onde você planeja usá-lo.
Passo 2: Instale o Kit no Seu Projeto no Codex
Abra o projeto de destino no Codex e execute:
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -yEste comando instala as habilidades da YCloud no projeto atual. Após a instalação, inicie uma nova sessão no Codex para que ele possa descobrir as habilidades recém-instaladas.
Consulte as instruções de instalação do YCloud Developer Kit para obter os detalhes completos da configuração.
Etapa 3: Verificar a Instalação
Em uma nova tarefa do Codex, insira:
Use $ycloud-developer-kit-smoke-test to check whether the plugin is ready.A resposta esperada é:
YCloud Developer Kit is ready. No external API was called.Isso confirma que o Codex pode encontrar e usar o Kit. Ele não valida as credenciais da conta YCloud nem envia uma mensagem no WhatsApp.
Assim que o teste de fumaça for bem-sucedido, o Kit estará pronto para trabalhar em um requisito de integração definido.
Como Construir uma Integração de Confirmação de Pedidos no WhatsApp
O Que Estamos Construindo?
Considere um fluxo de trabalho de confirmação de pedido:
- Um cliente faz um pedido.
- O backend prepara uma confirmação no WhatsApp.
- A mensagem é associada ao pedido.
- Eventos posteriores de entrega ou falha atualizam o registro de notificação.
Neste exemplo, a aplicação usa Node.js, Express e SQLite. Todos os pedidos, respostas do YCloud e eventos de Webhook são simulados.
Transmissões de marketing, mensagens recebidas e gerenciamento de campanhas estão fora deste exemplo.
Etapa 1: Descreva o Requisito no Codex
Em vez de selecionar APIs ou habilidades individuais, comece descrevendo o fluxo de trabalho completo da empresa:
Use $ycloud-integration-architect to build a local WhatsApp
order-confirmation integration.
Our backend uses Node.js, Express and SQLite.
When a customer places an order:
- Prepare a WhatsApp order-confirmation message
- Associate the message with the order
- Process later delivery or failure events
- Prevent duplicate Webhook events from causing repeated updates
Implement the workflow in the current local project and add tests.
Use fictional orders and simulated YCloud responses.
Do not read real credentials or call real APIs.
After completing the work, provide:
1. The integration flow
2. Changed files
3. Configuration placeholders
4. Executed tests and actual results
5. Items that still require verification with YCloudEste único prompt define o objetivo do negócio, a pilha de tecnologia, o fluxo de trabalho necessário, as ações permitidas, os cenários de teste e o resultado esperado.
Etapa 2: Revise o Plano Gerado
O Codex primeiro mapeia o requisito de negócio para os componentes de integração necessários.
Para este fluxo de trabalho, o plano deve cobrir:
- Criação de pedido como o gatilho
- Preparação e envio de mensagem pelo WhatsApp
- Conexão entre o pedido e o registro da mensagem
- Processamento do Webhook de status da mensagem
- Tratamento de eventos duplicados
- Tratamento de falhas e timeouts
- Requisitos de conta, número de telefone e template
Revise estes pontos para confirmar que o fluxo de trabalho proposto corresponde aos requisitos da aplicação.
Passo 3: Deixe o Codex Implementar o Fluxo de Trabalho
Como o prompt autoriza alterações no projeto local atual, o Codex pode implementar o fluxo de trabalho definido e adicionar seus testes.
A implementação gerada pode incluir:
- Lógica de confirmação de pedido
- Adaptador de solicitação do YCloud
- Placeholders de configuração
- Correlação entre mensagem e pedido
- Receptor de Webhook
- Lógica de processamento de status
- Testes locais
- Instruções de execução
Após a implementação, o Codex deve listar todos os arquivos que criou ou alterou. Isso dá aos desenvolvedores um resumo claro do trabalho que precisa ser revisado.
Passo 4: Execute os Testes Simulados
Importante: Este exemplo usa respostas simuladas do YCloud e eventos sintéticos de Webhook. Ele não se conecta a uma conta ao vivo do YCloud ou envia uma mensagem real pelo WhatsApp.
Os testes locais cobrem:
- Submissão de solicitação bem-sucedida
- Rejeição da API
- Status de mensagem falha posteriormente
- Timeout de solicitação
- Evento de status duplicado
- Webhook Inválido
O resultado gravado foi:
24 tests passed
0 failed
0 skippedEsses resultados confirmam que os cenários locais definidos produziram os resultados esperados.
Eles também mostram que:
- O envio da solicitação e os status posteriores da mensagem são armazenados separadamente.
- Eventos duplicados não acionam atualizações de negócios repetidas.
- Uma solicitação com tempo esgotado permanece incerta.
- O aplicativo não reenvia automaticamente após um tempo limite incerto.
Os resultados aplicam-se apenas aos cenários simulados testados.
Passo 5: Identificar o que Falta Antes da Produção
O Codex também pode separar o trabalho local concluído das tarefas que ainda requerem o ambiente autorizado do YCloud:
- Configurar a conta do YCloud e o número de telefone do WhatsApp.
- Confirmar o modelo de mensagem aprovado.
- Adicionar a chave de API do lado do servidor.
- Configurar o endpoint público do Webhook.
- Testar solicitações reais e callbacks de status.
- Concluir a revisão de código, monitoramento e implantação.
O fluxo de trabalho local agora está implementado e testado em relação às simulações definidas.
O trabalho restante ocorre no ambiente autorizado do YCloud e de implantação da equipe.
O que Este Exemplo Demonstra?
O YCloud Developer Kit ajuda a mover um requisito de negócio definido por meio do planejamento, implementação local, testes e transferência técnica dentro do Codex.
Entrada | Resultado |
| Um fluxo de trabalho de negócios definido | Um plano de integração estruturado |
| Uma solicitação de implementação | Placeholders de código e configuração local |
| Cenários de teste simulados definidos | Resultados de caminho normal e de falha registrados |
| Uma solicitação de handoff | Requisitos restantes do YCloud e de implantação |
Isso permite que os desenvolvedores trabalhem no processo completo de desenvolvimento de integração sem precisar identificar manualmente cada capacidade ou etapa de implementação do YCloud.
Considerações Finais
O YCloud Developer Kit fornece um caminho direto desde a instalação até o desenvolvimento de integração local. Instale e verifique o Kit, descreva claramente um fluxo de trabalho de negócios e deixe o Codex planejar, implementar e testar dentro do projeto definido.
A configuração da conta, a implantação em produção e a verificação no ambiente real permanecem etapas separadas.
Para a lista completa de capacidades, níveis de validação, práticas de segurança e considerações de produção, leia YCloud Developer Kit: Crie e Teste Integrações de API do WhatsApp com o Codex.
Comece a Construir com o YCloud Developer Kit
Instale o YCloud Developer Kit, abra uma nova tarefa no Codex e descreva o fluxo de trabalho do WhatsApp que deseja construir.
Saiba mais sobre o YCloud Developer Kit completo AQUI
Frequently Asked Questions
O YCloud Developer Kit é o mesmo que o Painel do YCloud?
Não. O YCloud Developer Kit é um assistente de desenvolvimento de integração usado dentro do Codex. As operações de mensagens e o gerenciamento de campanhas usam ferramentas separadas.
A instalação do kit o conecta a uma conta YCloud?
Não. O acesso à conta YCloud, credenciais e recursos externos devem ser configurados separadamente.
Pode enviar mensagens reais pelo WhatsApp?
Não por si só.
A versão 0.7.9 pode ajudar os desenvolvedores a escrever código de aplicativo que envia mensagens através do YCloud. No entanto, o Kit não lê credenciais ao vivo, chama APIs do YCloud ou envia mensagens reais durante seu fluxo de trabalho. O envio real ocorre separadamente através do aplicativo configurado em um ambiente autorizado.
Os desenvolvedores precisam fornecer uma chave de API durante o planejamento?
Não. O planejamento, exemplos de código e testes simulados podem usar espaços reservados e dados sintéticos.
Ele pode modificar um projeto existente?
Sim. O desenvolvedor deve autorizar explicitamente as alterações de arquivos locais e definir o projeto, módulos e escopo permitido.
Uma simulação aprovada significa que a integração está pronta para produção?
Não. Uma simulação valida apenas os cenários locais definidos. A configuração de produção e os testes contra o YCloud ainda são necessários.
Ele Pode Ajudar a Construir o Tratamento de Mensagens Recebidas?
Sim. Ele pode ajudar a implementar manipuladores de Webhook que validam e encaminham eventos de mensagens recebidas para a lógica de negócios do aplicativo.
Ele oferece suporte a modelos, contatos e gerenciamento de cancelamentos?
Sim. A versão 0.7.9 inclui orientações dedicadas para fluxos de trabalho de modelos, contatos e cancelamentos de assinatura.
Ele suporta SMS, Voz, Verificação ou E-mail?
As integrações de SMS, Verify, YCloud Voice e Email estão fora do escopo declarado da versão 0.7.9.
WhatsApp Calling é suportado e é separado do YCloud Voice.
O Que Acontece Se a Documentação Oficial da API Não Puder Ser Verificada?
Marque o exemplo como não verificado e identifique os endpoints, campos ou comportamentos que ainda precisam de confirmação.
Se o Kit retornar:
"synthetic_unverified"
Significa que o resultado foi produzido com dados sintéticos e os detalhes do contrato declarados não foram totalmente verificados. Não é um status da API YCloud ou evidência de testes reais de integração.
Artigos Relacionados
Torne suas comunicações empresariais muito mais fáceis！
Confiado por
