对接指南

最后更新:2026-09-29 08:43:16

一、文档说明

文档目的

本文档指导开发人员如何对接 AI 生成图像接口,完成 AI 服务的调试与使用。

适用对象

  • 开发人员
  • 系统集成商
  • 需要使用 AI 生图服务的技术人员

对接流程概览

注册认证 → 选择模型 → 提交任务 → 异步生成 → 接收结果 → 管理账户

二、对接流程概览

6 步完成对接

步骤 说明
1. 注册认证 获取商户 ID、商户密钥,联系平台负责人获取即可
2. 选择模型 创建 AI 任务时需传入模板 ID,该模板对应的大数据模型将用于生成 AI 图像
3. 创建 AI 任务 向系统提交一个生成图像的请求,包含模板 ID 和描述内容等,系统会异步处理并返回生成的图像
4. 异步回调通知 创建 AI 任务后,系统会通过 callback 异步通知任务结果
5. 消费记录 查看使用 AI 服务时产生的费用明细,包括每次生成图像的消耗情况
6. 商户信息 查看当前账户的基本资料,包括商户 ID、余额等关键信息

三、AI 模型列表

注册认证

获取方式: 联系平台负责人获取商户 ID 和商户密钥。

项目 说明
商户 ID 账户唯一标识
商户密钥 用于接口签名验证,需妥善保管

选择模型

创建 AI 任务时需传入模板 ID,该模板对应的大数据模型将用于生成 AI 图像。

说明:

  • 每个模板 ID 对应一种 AI 生成模型
  • 不同模型适用于不同的图像生成场景
  • 具体模板列表可调用"获取模板"接口查询

创建 AI 任务

向系统提交一个生成图像的请求。

请求参数包括:

  • 模板 ID(选择 AI 模型)
  • 描述内容(生成图像的创意描述)
  • 其他可选参数

处理方式: 系统会异步处理并返回生成的图像。

异步回调通知

创建 AI 任务后,系统会通过 callback 异步通知任务结果。

回调内容:

  • 任务状态
  • 生成的图像 URL
  • 其他任务信息

四、接口调用

接口列表

AI 接口支持以下 5 个接口:

序号 接口名称 用途 文档链接
1 商户签名 生成接口调用签名 查看
2 获取模板 获取可用的 AI 模板列表 查看
3 创建 AI 任务 提交 AI 图像生成请求 查看
4 消费记录 查看 AI 服务消费明细 查看
5 商户信息 查看账户基本信息 查看

调用流程

1. 获取商户 credentials → 2. 生成签名 → 3. 获取模板 → 4. 创建 AI 任务 → 5. 接收回调 → 6. 查看消费记录

五、常见问题 FAQ

Q1:如何获取商户 ID 和商户密钥?

答: 联系平台负责人获取即可。


Q2:模板 ID 是什么?

答: 模板 ID 对应一个 AI 生成模型,创建 AI 任务时需要传入,系统会根据该模板生成 AI 图像。


Q3:如何获取可用的模板列表?

答: 调用"获取模板"接口,可以查询所有可用的 AI 模板及其 ID。


Q4:创建 AI 任务需要提供什么参数?

答: 主要参数包括:

  • 模板 ID(选择 AI 模型)
  • 描述内容(生成图像的创意描述)
  • 其他可选参数(参考接口文档)

Q5:AI 任务是如何返回结果的?

答: 系统采用异步处理方式:

  1. 提交任务后,系统立即返回任务 ID
  2. 任务处理完成后,通过 callback 异步通知结果
  3. 回调中包含生成的图像 URL

Q6:如何查看 AI 服务的消费记录?

答: 调用"消费记录"接口,可以查看使用 AI 服务时产生的费用明细,包括每次生成图像的消耗情况。


Q7:如何查看账户信息?

答: 调用"商户信息"接口,可以查看当前账户的基本资料,包括商户 ID、余额等关键信息。


Q8:商户签名是什么?

答: 商户签名用于接口调用时的身份验证,确保请求安全。具体生成方法参考"商户签名"文档。


Q9:AI 生成图像需要多长时间?

答: 当前生成一张图像预计时间在30S左右,系统采用异步处理方式,具体生成时间取决于图像复杂度和系统负载。生成完成后会通过回调通知。


相关文档

以下文档与 AI 接口对接相关,可能需要配合查看:

文档 用途
关于 AI 接口 AI 接口详细说明
商户签名 生成接口调用签名
获取模板 获取可用的 AI 模板列表
创建 AI 任务 提交 AI 图像生成请求
消费记录 查看 AI 服务消费明细
商户信息 查看账户基本信息

恭喜,你已经完成了 AI 生成图像接口的基本对接,可以在业务场景中正式使用了!


若设备在调试过程中遇到不能解决问题,可以联系云打印负责人排除问题,找到解决的方法。联系方法如下: 电 话:137-5177-4454【微信同号】 邮 箱:info@ColorPark.cn

软硬件深度整合的UV云打印服务商 ® 瑞丰彩