API对接
对接流程
开通商户
联系无界商务人员,由无界魔镜管理员在魔镜后台开通商户。
购买作画张数
魔镜API商户需线下和商务对接进行充值,购买作画张数以及模版,由管理员在魔镜后台分配张数和模版。
调试API鉴权
开通成功后,用户登陆 魔镜后台 获取密钥,通过密钥调通API鉴权流程,详见下方Demo。
接入作画API
接入API时的问题反馈
API接入遇到问题时,建议优先向我们反馈响应Header中的TRACE_ID以快速定位问题。API异常码见文末列表。
签名流程
签名步骤
平台提供appid和公私钥,API接入方根据这个信息先完成鉴权签名流程,每个API的请求头都需要加上。
创建签名
创建签名原文
{"appId":"appId","timestamp":当前时间戳}
(字段按字母顺序排序),使用私钥进行 SHA256withRSA 签名,再进行Base64处理。签名加到请求头,发起API请求
在Request Header中的添加 Authorization 字段,字段值格式为
{"secretKeyVersion":"1","appId":"你的appid","sign":"签名sign", "original": "签名原文"}
发起API请求
API鉴权成功,Http状态码会返回200
Http状态码
状态码 | 描述 |
---|---|
400 | 参数不合法 |
401 | 权限不足 |
403 | 签名鉴权不通过 |
405 | 请求方式错误 |
429 | 请求API限流 |
415 | 传参的资源类型错误,需正确设置content-type:application/json |
业务响应报文
正常
异常
非法参数
{
"code": "200",
"data": {
//数据
},
"message": "success",
"success": true
}
修改于 2025-01-15 10:19:47