Berapa banyak pekerjaan yang diperlukan untuk memulai integrasi YCloud di Codex?
YCloud Developer Kit membawa keterampilan integrasi spesifik YCloud ke dalam Codex.
Untuk menunjukkan cara kerjanya, artikel ini menggunakan alur kerja konfirmasi pesanan WhatsApp yang terfokus dengan data yang disimulasikan.
Anda akan menginstal dan memverifikasi Kit, kemudian menggunakan satu perintah untuk merencanakan integrasi, mengimplementasikannya secara lokal, dan menjalankan tes simulasi.
Pilih Instal atau Coba sekarang, dan pastikan Kit diaktifkan di lingkungan Codex tempat Anda berencana menggunakannya.
Langkah 2: Instal Kit di Proyek Codex Anda
Buka proyek target di Codex dan jalankan:
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -y
Perintah ini menginstal keterampilan YCloud di proyek saat ini. Setelah penginstalan, mulai sesi Codex baru agar dapat menemukan keterampilan yang baru diinstal.
Use $ycloud-developer-kit-smoke-test to check whether the plugin is ready.
Respons yang diharapkan adalah:
YCloud Developer Kit is ready. No external API was called.
Ini mengonfirmasi bahwa Codex dapat menemukan dan menggunakan Kit. Ini tidak memvalidasi kredensial akun YCloud atau mengirim pesan WhatsApp.
Setelah smoke test berhasil, Kit siap untuk bekerja pada persyaratan integrasi yang ditentukan.
Cara Membangun Integrasi Konfirmasi Pesanan WhatsApp
Apa yang Kita Bangun?
Pertimbangkan alur kerja konfirmasi pesanan:
Pelanggan melakukan pemesanan.
Backend menyiapkan konfirmasi WhatsApp.
Pesan tersebut dikaitkan dengan pesanan.
Peristiwa pengiriman atau kegagalan selanjutnya memperbarui catatan notifikasi.
Untuk contoh ini, aplikasi menggunakan Node.js, Express, dan SQLite. Semua pesanan, respons YCloud, dan event Webhook disimulasikan.
Siaran pemasaran, pesan masuk, dan manajemen kampanye berada di luar contoh ini.
Langkah 1: Jelaskan Persyaratan dalam Codex
Alih-alih memilih API atau keterampilan individu, mulailah dengan menjelaskan keseluruhan alur kerja bisnis:
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
Prompt tunggal ini mendefinisikan tujuan bisnis, tumpukan teknologi, alur kerja yang diperlukan, tindakan yang diizinkan, skenario uji, dan output yang diharapkan.
Langkah 2: Tinjau Rencana yang Dihasilkan
Codex pertama-tama memetakan kebutuhan bisnis ke komponen integrasi yang diperlukan.
Untuk alur kerja ini, rencana harus mencakup:
Pembuatan pesanan sebagai pemicu
Penyusunan dan pengiriman pesan WhatsApp
Koneksi antara pesanan dan catatan pesan
Pemrosesan Webhook status pesan
Penanganan duplikat peristiwa
Penanganan kegagalan dan batas waktu
Persyaratan akun, nomor telepon, dan templat
Tinjau poin-poin ini untuk memastikan bahwa alur kerja yang diusulkan sesuai dengan kebutuhan aplikasi.
Langkah 3: Biarkan Codex Mengimplementasikan Alur Kerja
Karena perintah tersebut mengizinkan perubahan pada proyek lokal saat ini, Codex dapat mengimplementasikan alur kerja yang telah ditentukan dan menambahkan pengujiannya.
Implementasi yang dihasilkan mungkin mencakup:
Logika konfirmasi pesanan
Adaptor permintaan YCloud
Placeholder konfigurasi
Korelasi pesanan ke pesan
Penerima Webhook
Logika pemrosesan status
Pengujian lokal
Instruksi menjalankan
Setelah implementasi, Codex harus mencantumkan setiap file yang dibuat atau diubah. Ini memberikan ringkasan jelas kepada pengembang tentang pekerjaan yang perlu ditinjau.
Langkah 4: Jalankan Pengujian Simulasi
Penting: Contoh ini menggunakan respons YCloud simulasi dan peristiwa Webhook sintetis. Ini tidak terhubung ke akun YCloud langsung atau mengirim pesan WhatsApp yang sebenarnya.
Pengujian lokal mencakup:
Pengajuan permintaan yang berhasil
Penolakan API
Status pesan yang gagal kemudian
Batas waktu permintaan
Peristiwa status duplikat
Webhook Tidak Valid
Hasil yang direkam adalah:
24 tests passed
0 failed
0 skipped
Hasil ini mengkonfirmasi bahwa skenario lokal yang didefinisikan menghasilkan hasil yang diharapkan.
Mereka juga menunjukkan bahwa:
Pengajuan permintaan dan status pesan selanjutnya disimpan secara terpisah.
Peristiwa duplikat tidak memicu pembaruan bisnis yang berulang.
Permintaan yang mengalami timeout tetap tidak pasti.
Aplikasi tidak secara otomatis mengirim ulang setelah timeout yang tidak pasti.
Hasil ini hanya berlaku untuk skenario simulasi yang diuji.
Langkah 5: Mengidentifikasi Apa yang Tersisa Sebelum Produksi
Codex juga dapat memisahkan pekerjaan lokal yang telah selesai dari tugas yang masih memerlukan lingkungan YCloud yang berwenang:
Konfigurasikan akun YCloud dan nomor telepon WhatsApp.
Konfirmasikan template pesan yang disetujui.
Tambahkan kunci API sisi server.
Konfigurasikan endpoint Webhook publik.
Uji permintaan nyata dan panggilan balik status.
Selesaikan tinjauan kode, pemantauan, dan penerapan.
Alur kerja lokal sekarang telah diimplementasikan dan diuji terhadap simulasi yang didefinisikan.
Pekerjaan yang tersisa dilakukan di lingkungan YCloud dan penerapan yang berwenang bagi tim.
Apa yang Ditunjukkan oleh Contoh Ini?
YCloud Developer Kit membantu memindahkan persyaratan bisnis yang didefinisikan melalui perencanaan, implementasi lokal, pengujian, dan serah terima teknis dalam Codex.
Masukan
Hasil
Satu alur kerja bisnis yang didefinisikan
Rencana integrasi terstruktur
Satu permintaan implementasi
Placeholder kode dan konfigurasi lokal
Skenario uji simulasi yang ditentukan
Mencatat hasil jalur normal dan kegagalan
Satu permintaan handoff
Sisa persyaratan YCloud dan deployment
Ini memungkinkan pengembang untuk bekerja melalui proses pengembangan integrasi lengkap tanpa harus mengidentifikasi setiap kemampuan YCloud atau langkah implementasi secara manual.
Pikiran Terakhir
YCloud Developer Kit memberikan jalur langsung dari instalasi hingga pengembangan integrasi lokal. Instal dan verifikasi Kit, jelaskan satu alur kerja bisnis dengan jelas, dan biarkan Codex merencanakan, mengimplementasikan, dan mengujinya dalam proyek yang telah ditentukan.
Konfigurasi akun, deployment produksi, dan verifikasi lingkungan nyata tetap menjadi langkah terpisah.
Apakah YCloud Developer Kit Sama dengan YCloud Dashboard?
Developer Kit No. YCloud adalah asisten pengembangan integrasi yang digunakan dalam Codex. Operasi pesan dan manajemen kampanye menggunakan alat terpisah.
Apakah Pemasangan Kit Menghubungkannya ke Akun YCloud?
Akses akun YCloud, kredensial, dan sumber daya eksternal harus dikonfigurasi secara terpisah.
Bisakah Mengirim Pesan WhatsApp Nyata?
Tidak sendiri.
Versi 0.7.9 dapat membantu developer menulis kode aplikasi yang mengirim pesan melalui YCloud. Namun, Kit ini tidak membaca kredensial langsung, memanggil API YCloud, atau mengirim pesan sungguhan selama alur kerjanya. Pengiriman sungguhan terjadi terpisah melalui aplikasi yang dikonfigurasi dalam lingkungan yang telah diotorisasi.
Apakah Developer Perlu Menyediakan API Key Selama Tahap Perencanaan?
Tidak. Perencanaan, contoh kode, dan pengujian simulasi dapat menggunakan placeholder dan data sintetis.
Dapatkah Ini Memodifikasi Proyek yang Sudah Ada?
Ya. Developer harus secara eksplisit mengotorisasi perubahan file lokal dan mendefinisikan proyek, modul, serta cakupan yang diizinkan.
Apakah Simulasi yang Berhasil Berarti Integrasi Siap Produksi?
Tidak. Simulasi hanya memvalidasi skenario lokal yang telah ditentukan. Konfigurasi produksi dan pengujian terhadap YCloud masih diperlukan.
Apakah Itu Dapat Membantu Membangun Penanganan Pesan Masuk?
Ya. Ini dapat membantu menerapkan penangan Webhook yang memvalidasi dan mengarahkan peristiwa pesan masuk ke logika bisnis aplikasi.
Apakah Mendukung Template, Kontak, dan Manajemen Berhenti Berlangganan?
Ya. Versi 0.7.9 mencakup panduan khusus untuk alur kerja template, kontak, dan pelanggan yang berhenti berlangganan.
Apakah Mendukung SMS, Suara, Verifikasi, atau Email?
Integrasi No. SMS, Verify, YCloud Voice, dan Email berada di luar cakupan yang dinyatakan pada versi 0.7.9.
WhatsApp Calling didukung dan terpisah dari YCloud Voice.
Apa yang Terjadi Jika Dokumentasi API Resmi Tidak Dapat Diverifikasi?
Tandai contoh sebagai tidak terverifikasi dan identifikasi endpoint, bidang, atau perilaku yang masih memerlukan konfirmasi.
Jika Kit mengembalikan:
"synthetic_unverified"
Artinya hasil tersebut dihasilkan dengan data sintetis dan detail kontrak yang dinyatakan tidak sepenuhnya diverifikasi. Ini bukan status API YCloud atau bukti pengujian integrasi nyata.