API 与集成
使用文档说明的推理 API 或模型训练 API、按需授权的凭证，以及最新用量和 API 参考来连接应用。
- 选择 API 产品区分推理请求与模型训练工作流程。
- 阅读接口约定查看对应的 API 文档和 OpenAPI 参考。
- 创建受限密钥生成并妥善保管客户 API 密钥。
- 集成并验证发送文档说明的请求并检查响应。
- 监控并轮换密钥查看用量，并在适当时撤销或轮换密钥。
选择正确的 API 工作流程
推理 API 用于模型推理请求；模型训练 API 则介绍另一套训练流程，包括报价、作业、会话和产物。不要假设推理端点会启动训练，也不要认为训练操作可通过推理接口调用。请阅读拟使用产品的文档，并确认其中列出了所需模型或训练能力。应按照已公布的请求和响应结构集成，不要根据熟悉的第三方 SDK 自行推断方法名称。
- 确认应用需要模型推理还是模型训练。
- 打开对应产品的文档和 API 参考。
- 确认文档列出了所需能力和模型。
创建并保护 API 密钥
从已登录的 API 密钥页面创建客户 API 密钥；界面提供范围选项时，只选择集成所需的权限。密钥只会显示一次，请直接将其存入获准的密钥管理器；不要提交到源代码库、粘贴到日志或暴露在浏览器代码中。条件允许时，请按应用和环境标记凭证。开发和生产环境应使用不同凭证，以便撤销其中一个凭证时不影响其他集成。
- 在已登录的客户工作区打开“API 密钥”。
- 创建具有最小必需权限范围的密钥。
- 安全保存密钥，并确保它不会出现在源代码或日志中。
按照已公布的接口约定实现
根据相关 API 指南处理身份验证、端点、请求字段、响应和错误。服务凭证应保留在可信服务器上，不要放入公开客户端代码。发送请求前验证输入，明确处理失败响应，并避免记录 Authorization 标头或敏感提示词数据。需要机器可读的接口约定时，请参考 OpenAPI 文档。除非当前文档明确列出，否则不要推断支持流式输出、多媒体或提供商原生操作。
- 只实现所选 API 文档中说明的操作和字段。
- 在服务器端保管凭证，并从诊断信息中删除敏感内容。
- 按文档处理错误；响应提供请求标识时请妥善保留。
监控用量并管理凭证
集成完成后，请查看用量页面，了解账户关联的活动，并与应用自身记录进行对照。增加流量或创建额外凭证前，应先调查异常变化。如果密钥可能已经泄露，请先轮换密钥，再更新应用的密钥存储并验证集成，之后才移除仍在使用的旧凭证。撤销不再需要的密钥。用量显示可用于运营审查，但不保证未来费用或容量。
- 将平台用量与应用记录的请求进行对照。
- 轮换已泄露的凭证，并验证替换后的凭证。
- 撤销未使用的密钥，并定期检查访问权限。
常见问题
推理和模型训练使用的是同一个 API 吗？
不是。两者是不同产品，工作流程也不同。请根据所需能力查阅对应的参考文档。
在哪里可以找到受支持的 API 约定？
请查看本指南链接的产品文档和 OpenAPI 参考，其中说明当前已公布的接口。
API 密钥应存放在哪里？
请使用安全的服务器端密钥管理器。切勿将密钥提交到代码库、暴露在浏览器代码中或写入日志。
密钥泄露后该怎么办？
在“API 密钥”中轮换或撤销该密钥，在应用密钥存储中替换密钥，并检查近期用量是否存在异常活动。