客户支持
中文
如何在Codex中安装YCloud开发者工具包并构建WhatsApp API集成
在 Codex 中启动 YCloud 集成需要多少工作？
YCloud 开发者工具包将 YCloud 专属的集成技能引入 Codex。
为了演示其工作原理，本文使用了一个聚焦于 WhatsApp 订单确认的工作流程，并模拟了数据。
您将安装并验证该工具包，然后使用单一提示来规划集成，在本地实施并运行模拟测试。
有关支持的功能、安全指导和生产考虑，请阅读 YCloud 开发者工具包：使用 Codex 构建和测试 WhatsApp API 集成。
如何在 Codex 中安装 YCloud 开发者工具包
步骤 1：打开 YCloud 开发者工具包
选择 安装 或 立即试用，并确认该工具包已在您计划使用的 Codex 环境中启用。
步骤 2：在您的 Codex 项目中安装工具包
在 Codex 中打开目标项目并运行：
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -y此命令在当前项目中安装了 YCloud 技能。安装完成后，启动一个新的 Codex 会话，以便它可以发现新安装的技能。
第三步：验证安装
在新的Codex任务中输入：
Use $ycloud-developer-kit-smoke-test to check whether the plugin is ready.预期响应为：
YCloud Developer Kit is ready. No external API was called.这确认了Codex能找到并使用该工具包。它不会验证YCloud账户凭据或发送WhatsApp消息。
冒烟测试通过后，该工具包即可以处理定义的集成需求。
如何构建WhatsApp订单确认集成
我们要构建什么？
考虑以下订单确认工作流：
- 客户下订单。
- 后端准备WhatsApp确认消息。
- 消息与订单关联。
- 后续配送或失败事件会更新通知记录。
本示例应用使用Node.js、Express和SQLite。所有订单、YCloud响应和Webhook事件均为模拟数据。
营销广播、接收消息和活动管理不在本示例范围内。
第一步：在Codex中描述需求
无需选择单个API或技能，首先描述完整的业务工作流：
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这个单一提示定义了业务目标、技术栈、所需工作流、允许操作、测试场景和预期输出。
第二步：审查生成的计划
Codex 首先将业务需求映射到所需的集成组件。
对于此工作流，计划应包括：
- 订单创建作为触发器
- WhatsApp 消息准备和提交
- 订单和消息记录之间的连接
- 消息状态 Webhook 处理
- 重复事件处理
- 失败和超时处理
- 账户、电话号码和模板要求
审查这些要点以确认拟议的工作流符合应用程序的要求。
第三步：让 Codex 实现工作流
由于提示授权对当前本地项目进行更改，Codex 可以实现定义的工作流并添加其测试。
生成的实现可能包括：
- 订单确认逻辑
- YCloud 请求适配器
- 配置占位符
- 消息到订单的关联
- Webhook 接收器
- 状态处理逻辑
- 本地测试
- 运行说明
实现后，Codex 应列出它创建或更改的每个文件。这为开发人员提供了需要审查的工作的清晰摘要。
第四步：运行模拟测试
重要提示： 此示例使用模拟的 YCloud 响应和合成的 Webhook 事件。它不会连接到实时的 YCloud 账户或发送真实的 WhatsApp 消息。
本地测试涵盖：
- 成功的请求提交
- API 拒收
- 后期失败的消息状态
- 请求超时
- 重复状态事件
- 无效的Webhook
记录的结果是：
24 tests passed
0 failed
0 skipped这些结果确认了定义的本地场景产生了预期的结果。
它们还表明：
- 请求提交和后续消息状态是分别存储的。
- 重复事件不会触发重复的业务更新。
- 超时的请求仍然不确定。
- 应用程序不会在不确定的超时后自动重新发送。
这些结果仅适用于测试的模拟场景。
步骤5：确定在上线前还需要完成的工作
Codex还可以将已完成的本地工作与仍需在授权的YCloud环境中完成的任务分开：
- 配置YCloud账户和WhatsApp电话号码。
- 确认已批准的消息模板。
- 添加服务器端API密钥。
- 配置公共Webhook端点。
- 测试真实的请求和状态回调。
- 完成代码审查、监控和部署。
本地工作流现已实现，并根据定义的模拟场景进行了测试。
剩余的工作将在团队授权的YCloud和部署环境中进行。
这个示例展示了什么？
YCloud开发者工具包帮助将一个定义的业务需求通过规划、本地实现、测试和技术交接在Codex中推进。
输入 | 结果 |
| 一个定义的业务工作流 | 一个结构化的集成计划 |
| 一个实现请求 | 本地代码和配置占位符 |
| 定义的模拟测试场景 | 记录的常规和故障路径结果 |
| 一次移交请求 | 剩余的 YCloud 和部署要求 |
这使得开发人员无需手动识别每个 YCloud 功能或实施步骤，即可完成整个集成开发过程。
最终思考
YCloud 开发者工具包提供了一条从安装到本地集成开发的直接路径。安装并验证工具包，清楚地描述一个业务工作流程，然后让 Codex 在定义的项目中规划、实施和测试它。
账户配置、生产部署和真实环境验证仍然是单独的步骤。
有关完整的功能列表、验证级别、安全实践和生产注意事项，请阅读 YCloud 开发者工具包：使用 Codex 构建和测试 WhatsApp API 集成。
开始使用 YCloud 开发者工具包
安装 YCloud 开发者工具包，打开一个新的 Codex 任务并描述您想要构建的 WhatsApp 工作流程。
在此了解完整的 YCloud 开发者工具包
Frequently Asked Questions
YCloud开发者工具包和YCloud控制面板是同一个东西吗？
YCloud 开发套件是 Codex 平台内置的集成开发辅助工具。消息发送功能和营销活动管理需使用独立工具进行操作。
安装套件是否会将它与 YCloud 账户连接？
没有。YCloud 帐户访问、凭据和外部资源必须单独配置。
它能发送真实的 WhatsApp 消息吗？
仅靠它自己是不行的。
Version 0.7.9 可以帮助开发者编写通过YCloud发送消息的应用代码。然而，该工具包在工作流程中不会读取实时凭证、调用YCloud API或发送真实消息。真实的发送操作是在授权的环境中通过配置的应用程序单独进行的。
开发者在规划期间是否需要提供API密钥？
不。规划、代码示例和模拟测试可以使用占位符和合成数据。
它能修改现有项目吗？
是的。开发者必须明确授权本地文件更改，并定义项目、模块和允许的范围。
通过模拟测试是否意味着集成已具备生产就绪条件？
不。模拟仅验证定义的本地场景。仍需要对生产配置进行测试，并与YCloud进行对接。
能否帮助构建入站消息处理功能？
是的。它可以帮助实现 Webhook 处理器，该处理器可以验证并将传入消息事件路由到应用程序的业务逻辑。
它是否支持模板、联系人和退订管理？
是的。版本 0.7.9 包含了针对模板、联系人和退订工作流程的专用指南。
它是否支持短信、语音、验证或电子邮件？
短信、验证码、YCloud语音及邮件集成不属于0.7.9版本声明范畴。
WhatsApp通话功能已支持，该功能与YCloud语音相互独立。
如果无法验证官方API文档会发生什么？
将该示例标记为未验证，并识别仍需确认的端点、字段或行为。
如果Kit返回：
"synthetic_unverified"
这意味着结果是使用合成数据生成的，并且所声明的合同细节没有完全验证。它不是YCloud API的状态，也不是真实集成测试的证据。
让您的商务沟通更简单！
已加入
