Selecciona Instalar o Probar ahoray confirma que el Kit está habilitado en el entorno de Codex donde planeas usarlo.
Paso 2: Instala el Kit en tu Proyecto de Codex
Abre el proyecto objetivo en Codex y ejecuta:
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -y
Este comando instala las habilidades de YCloud en el proyecto actual. Después de la instalación, inicia una nueva sesión de Codex para que pueda descubrir las habilidades recién instaladas.
Use $ycloud-developer-kit-smoke-test to check whether the plugin is ready.
La respuesta esperada es:
YCloud Developer Kit is ready. No external API was called.
Esto confirma que Codex puede encontrar y usar el Kit. No valida las credenciales de la cuenta de YCloud ni envía un mensaje de WhatsApp.
Una vez que la prueba de humo tiene éxito, el Kit está listo para trabajar en un requisito de integración definido.
Cómo Construir una Integración de Confirmación de Pedidos por WhatsApp
¿Qué Estamos Construyendo?
Considera un flujo de trabajo de confirmación de pedidos:
Un cliente realiza un pedido.
El backend prepara una confirmación por WhatsApp.
El mensaje está asociado al pedido.
Eventos posteriores de entrega o fallo actualizan el registro de notificación.
Para este ejemplo, la aplicación utiliza Node.js, Express y SQLite. Todos los pedidos, respuestas de YCloud y eventos de Webhook están simulados.
Emisiones de marketing, mensajes entrantes y gestión de campañas quedan fuera de este ejemplo.
Paso 1: Describir el Requisito en Codex
En lugar de seleccionar APIs o habilidades individuales, comienza describiendo el flujo de trabajo empresarial completo:
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 YCloud
Este único indicador define el objetivo empresarial, la pila tecnológica, el flujo de trabajo requerido, las acciones permitidas, los escenarios de prueba y el resultado esperado.
Paso 2: Revisar el Plan Generado
Codex primero mapea el requisito empresarial a los componentes de integración requeridos.
Para este flujo de trabajo, el plan debe cubrir:
Creación de pedido como disparador
Preparación y envío de mensaje WhatsApp
Conexión entre el pedido y el registro del mensaje
Procesamiento del webhook de estado del mensaje
Manejo de eventos duplicados
Manejo de fallos y tiempos de espera agotados
Requisitos de cuenta, número de teléfono y plantilla
Revise estos puntos para confirmar que el flujo de trabajo propuesto cumple con los requisitos de la aplicación.
Paso 3: Permita que Codex implemente el flujo de trabajo
Dado que la indicación autoriza cambios al proyecto local actual, Codex puede implementar el flujo de trabajo definido y agregar sus pruebas.
La implementación generada puede incluir:
Lógica de confirmación de pedido
Adaptador de solicitud YCloud
Marcadores de posición de configuración
Correlación mensaje-pedido
Receptor de webhook
Lógica de procesamiento de estado
Pruebas locales
Instrucciones de ejecución
Después de la implementación, Codex debe enumerar cada archivo que creó o modificó. Esto les da a los desarrolladores un resumen claro del trabajo que requiere revisión.
Paso 4: Ejecutar las pruebas simuladas
Importante: Este ejemplo utiliza respuestas simuladas de YCloud y eventos de webhook sintéticos. No se conecta a una cuenta real de YCloud ni envía un mensaje real de WhatsApp.
Las pruebas locales cubren:
Envío exitoso de solicitud
Rechazo de API
Estado posterior de mensaje fallido
Tiempo de espera agotado de solicitud
Evento de estado duplicado
Webhook no válido
El resultado grabado fue:
24 tests passed
0 failed
0 skipped
Estos resultados confirman que los escenarios locales definidos produjeron los resultados esperados.
También muestran que:
El envío de la solicitud y los estados posteriores del mensaje se almacenan por separado.
Los eventos duplicados no activan actualizaciones comerciales repetidas.
Una solicitud con tiempo de espera agotado permanece incierta.
La aplicación no reenvía automáticamente después de un tiempo de espera incierto.
Los resultados se aplican únicamente a los escenarios simulados probados.
Paso 5: Identificar lo que falta antes de la producción
Codex también puede separar el trabajo local completado de las tareas que aún requieren el entorno autorizado de YCloud:
Configurar la cuenta de YCloud y el número de teléfono de WhatsApp.
Confirmar la plantilla de mensaje aprobada.
Agregar la clave API del lado del servidor.
Configurar el punto final público del Webhook.
Probar solicitudes reales y devoluciones de estado.
Completar la revisión del código, monitoreo e implementación.
El flujo de trabajo local ahora está implementado y probado contra las simulaciones definidas.
El trabajo restante tiene lugar en los entornos autorizados de YCloud e implementación del equipo.
¿Qué demuestra este ejemplo?
YCloud Developer Kit ayuda a llevar un requisito comercial definido a través de la planificación, implementación local, pruebas y traspaso técnico dentro de Codex.
Entrada
Resultado
Un flujo de trabajo comercial definido
Un plan de integración estructurado
Una solicitud de implementación
Marcadores de posición de código y configuración local
Escenarios de prueba simulados definidos
Resultados registrados en rutas normales y de fallo
Una solicitud de traspaso
Requisitos restantes de YCloud y despliegue
Esto permite a los desarrolladores trabajar en el proceso completo de desarrollo de integración sin tener que identificar manualmente cada capacidad de YCloud o paso de implementación.
Reflexiones Finales
YCloud Developer Kit proporciona un camino directo desde la instalación hasta el desarrollo de integraciones locales. Instala y verifica el Kit, describe claramente un flujo de trabajo comercial y permite que Codex lo planifique, implemente y pruebe dentro del proyecto definido.
La configuración de la cuenta, el despliegue en producción y la verificación en entorno real siguen siendo pasos separados.
¿El Kit de Desarrollador de YCloud es lo mismo que el Panel de Control de YCloud?
No. YCloud Developer Kit es un asistente de desarrollo de integraciones que se utiliza dentro de Codex. Las operaciones de mensajería y la gestión de campañas utilizan herramientas separadas.
¿Instalar el kit lo conecta a una cuenta de YCloud?
No. El acceso a la cuenta de YCloud, las credenciales y los recursos externos deben configurarse por separado.
¿Puede enviar mensajes reales de WhatsApp?
No por sí solo.
La versión 0.7.9 puede ayudar a los desarrolladores a escribir código de aplicación que envíe mensajes a través de YCloud. Sin embargo, el Kit no lee credenciales en vivo, llama a las API de YCloud o envía mensajes reales durante su flujo de trabajo. El envío real ocurre por separado a través de la aplicación configurada en un entorno autorizado.
¿Los desarrolladores necesitan proporcionar una clave API durante la planificación?
No. La planificación, los ejemplos de código y las pruebas simuladas pueden usar marcadores de posición y datos sintéticos.
¿Puede modificar un proyecto existente?
Sí. El desarrollador debe autorizar explícitamente los cambios en los archivos locales y definir el proyecto, los módulos y el alcance permitido.
¿Significa que una simulación exitosa garantiza que la integración está lista para producción?
No. Una simulación solo valida los escenarios locales definidos. Todavía se requiere la configuración de producción y las pruebas con YCloud.
¿Puede ayudar a construir el manejo de mensajes entrantes?
Sí. Puede ayudar a implementar manejadores de Webhook que validen y dirijan eventos de mensajes entrantes a la lógica de negocio de la aplicación.
¿Admite plantillas, contactos y gestión de cancelación de suscripciones?
Sí. La versión 0.7.9 incluye orientación dedicada para flujos de trabajo de plantillas, contactos y cancelación de suscripción.
¿Admite SMS, voz, Verify o correo electrónico?
Las integraciones de No. SMS, Verify, YCloud Voice y Correo electrónico quedan fuera del alcance establecido para la versión 0.7.9.
WhatsApp Calling es compatible y está separado de YCloud Voice.
¿Qué sucede si la documentación oficial de la API no puede verificarse?
Marque el ejemplo como no verificado e identifique los puntos finales, campos o comportamientos que aún requieren confirmación.
Si el Kit devuelve:
"synthetic_unverified"
Significa que el resultado se produjo con datos sintéticos y los detalles del contrato declarados no se verificaron completamente. No es un estado de la API de YCloud ni una evidencia de pruebas de integración reales.