YCloud Developer Kit

O YCloud Developer Kit ajuda seu agente de programação por IA a planejar integrações, gerar código no lado do servidor e testar fluxos de trabalho no seu projeto existente. Descreva o que você deseja criar, como notificações de pedidos por WhatsApp, lembretes de consultas ou suporte ao cliente, e o agente usa os contratos da API da YCloud para guiar o trabalho. Você também pode pedir ao agente para revisar uma integração existente ou realizar uma operação de API real específica com suas credenciais do lado do servidor configuradas.

Antes de começar

Para a instalação e o desenvolvimento local, você precisa de:

Codex, Claude Code ou WorkBuddy.
Node.js e npx disponíveis no seu terminal.
O projeto no qual você deseja construir sua integração.

Você não precisa de uma chave de API da YCloud para a verificação de instalação ou testes que usem mocks. Para requisições reais à API, você precisa de uma conta YCloud, uma chave de API do lado do servidor e os recursos exigidos pelo seu fluxo de trabalho. Consulte Autenticação para a configuração de credenciais.

Instalar as habilidades

Execute o comando para o seu agente de programação a partir do diretório do seu projeto. Cada comando instala o conjunto completo de 17 habilidades nesse projeto.

Codex
Claude Code
WorkBuddy

npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -y

npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a claude-code --copy -y

O WorkBuddy usa o diretório de habilidades compatível com o CodeBuddy, .codebuddy/skills/.

npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codebuddy --copy -y

Para escolher seu agente de programação interativamente, execute:

npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*'

Você pode encontrar os pacotes ZIP versionados do plugin e os checksums na página oficial de versões.

Verificar a instalação

Inicie uma nova sessão no seu agente de programação e envie:

Use ycloud-developer-kit-smoke-test to check that YCloud Developer Kit is ready.

A resposta esperada é:

YCloud Developer Kit is ready. No external API was called.

Esta verificação confirma que o agente consegue descobrir e invocar a habilidade de prontidão. Ela não lê credenciais, não faz chamadas para a YCloud nem valida a configuração da sua conta. Se o agente não conseguir encontrar a habilidade, confirme se você executou o comando de instalação no projeto correto, selecionou o agente correto e abriu uma nova sessão para esse projeto.

Construir sua primeira integração

Descreva seu objetivo de negócio, a stack do projeto e o resultado necessário. Comece com ycloud-integration-architect quando o fluxo de trabalho abranger vários recursos, como modelos, envio de mensagens e webhooks. Por exemplo, envie este prompt a partir do projeto da sua aplicação:

Use ycloud-integration-architect to add WhatsApp order notifications to this project.
Reuse the existing framework and configuration patterns.
Send an existing approved template and handle delivery-status webhooks.
Keep the API key on the server and verify webhook signatures.
Add local tests with synthetic data and mocked YCloud responses.
Report the files changed, test results, and remaining setup.

O agente usa as habilidades de domínio relevantes para o seu fluxo de trabalho selecionado. Revise o código gerado e os resultados dos testes, depois configure os recursos necessários da YCloud antes de solicitar um teste com a API real. Forneça ao agente o seguinte contexto quando for relevante:

Contexto	Exemplo
Objetivo de negócio	Enviar uma confirmação de pedido pelo WhatsApp.
Stack existente	Reutilizar o backend Node.js e o executor de testes deste projeto.
Escopo	Usar um modelo existente; não criar nem editar modelos.
Ambiente de teste	Usar mocks com IDs sintéticos de cliente e mensagem.
Operação real	Obter o saldo da conta especificada usando a referência de credencial configurada.
Resultado esperado	Código do lado do servidor, testes locais e uma lista das etapas de configuração restantes.

Faça referência às credenciais por meio da configuração do seu servidor ou gerenciador de segredos. Não cole chaves de API nem segredos de assinatura de webhook em prompts.

O que o kit cobre

A versão 0.7.13 inclui 17 habilidades cobrindo 88 operações de API, além de autenticação de API e recebimento de webhooks. A tabela agrupa as habilidades de domínio pelo trabalho que você pode solicitar.

Recurso	Habilidade	Tarefas típicas
Autenticação de API	`ycloud-api-authentication`	Configurar chaves de API do lado do servidor e planejar a rotação de chaves.
Mensagens do WhatsApp	`ycloud-whatsapp-messages`	Enviar mensagens diretamente ou por meio da fila, e obter mensagens.
Mídia do WhatsApp	`ycloud-whatsapp-media`	Fazer upload de mídia para um fluxo de trabalho de mensagens.
Modelos do WhatsApp	`ycloud-whatsapp-templates`	Criar, listar, obter, editar e excluir modelos; obter análises.
Webhooks	`ycloud-webhook-endpoints`	Gerenciar endpoints e construir receptores com verificação de assinatura.
Contas do WhatsApp Business	`ycloud-whatsapp-business-accounts`	Listar e obter contas; gerenciar configurações de otimização criativa automática.
Números de telefone do WhatsApp	`ycloud-whatsapp-phone-numbers`	Gerenciar registro, perfis, nomes de exibição, nomes de usuário e configurações.
Grupos do WhatsApp	`ycloud-whatsapp-groups`	Gerenciar grupos, participantes, solicitações de entrada e links de convite.
WhatsApp Flows	`ycloud-whatsapp-flows`	Criar, atualizar, visualizar previamente, publicar, descontinuar e excluir Flows.
Confirmações de mensagens recebidas	`ycloud-whatsapp-inbound-messages`	Marque mensagens recebidas como lidas ou exiba um indicador de digitação.
Chamadas do WhatsApp	`ycloud-whatsapp-calling`	Gerencie sessões de chamada e baixe mídias de chamada.
Saldo da conta	`ycloud-balance`	Obtenha o saldo da conta.
Contatos	`ycloud-contacts`	Gerencie contatos e notas, e liste atributos de contato.
Eventos personalizados	`ycloud-custom-events`	Gerencie definições e propriedades de eventos e envie eventos associados a contatos.
Preferências de cancelamento de inscrição	`ycloud-unsubscribers`	Crie, consulte, liste e exclua registros de cancelamento de inscrição.

As duas habilidades restantes são ycloud-integration-architect, que coordena fluxos de trabalho entre domínios, e ycloud-developer-kit-smoke-test, que verifica a disponibilidade das habilidades instaladas.

Esta versão não abrange integrações de SMS, Verify, Voice ou Email. Esses produtos continuam disponíveis por meio das APIs da YCloud. Use os guias de API e as páginas de referência correspondentes para obter detalhes sobre a integração.

Mais exemplos de prompts

Adicionar mensagens recebidas e webhooks

Use YCloud Developer Kit to add WhatsApp inbound-message handling to this backend.
Verify webhook signatures and handle duplicate events.
Add local tests for valid signatures, invalid signatures, and repeated delivery.
Report the implementation changes and test results.

Revisar uma integração existente

Review this project's YCloud WhatsApp integration.
Check server-side authentication, request and response handling, delivery-status
webhooks, error handling, and retry behavior against the supported contracts.
Report findings and suggested fixes without changing files or calling live APIs.

Solicitar uma consulta à API real

Use ycloud-balance to retrieve the balance for the YCloud account identified in
this project's server configuration. Use the configured credential reference
without displaying the key. Report the returned amount and currency.

Testes locais e operações reais

Testes simulados locais permitem verificar o comportamento do aplicativo com dados sintéticos. Um teste simulado bem-sucedido não confirma a autenticação na API real, a entrega de mensagens ou a implantação em produção. Para operações reais, especifique a conta, o ambiente, os recursos de destino e a ação. O agente usa as credenciais configuradas dentro desse escopo. Ele solicita detalhes faltantes quando o destino ou os impactos não estiverem claros. Uma solicitação para desenvolver código localmente não autoriza alterações reais não relacionadas. Para envios de mensagens e outras operações assíncronas, diferencie uma solicitação aceita do seu resultado final. Verifique a entrega ou a conclusão por meio da API de consulta correspondente ou por Webhook. Se uma alteração real atingir o tempo limite, verifique o estado do recurso disponível antes de tentar novamente.

Primeiros passos

Guias

Endpoints

Webhook reference

Antes de começar

Instalar as habilidades

Verificar a instalação

Construir sua primeira integração

O que o kit cobre

Mais exemplos de prompts

Adicionar mensagens recebidas e webhooks

Revisar uma integração existente

Solicitar uma consulta à API real

Testes locais e operações reais

Próximos passos

Enviar uma mensagem pelo WhatsApp

Configurar webhooks

​Antes de começar

​Instalar as habilidades

​Verificar a instalação

​Construir sua primeira integração

​O que o kit cobre

​Mais exemplos de prompts

​Adicionar mensagens recebidas e webhooks

​Revisar uma integração existente

​Solicitar uma consulta à API real

​Testes locais e operações reais

​Próximos passos

Enviar uma mensagem pelo WhatsApp

Configurar webhooks

Antes de começar

Instalar as habilidades

Verificar a instalação

Construir sua primeira integração

O que o kit cobre

Mais exemplos de prompts

Adicionar mensagens recebidas e webhooks

Revisar uma integração existente

Solicitar uma consulta à API real

Testes locais e operações reais

Próximos passos