无界魔镜
  1. API接入指南
无界魔镜
  • 无界魔镜
    • 企业服务
    • 更新日志
    • 软件使用说明
      • 安装包
      • 运营后台
      • 操作示例
    • API接入指南
      • API对接
      • 作画出图速度
      • 作画价格说明
      • 作画审核
      • 无界魔镜企业智能客服
    • 魔镜作画API
      • 作画步骤说明
      • 模版信息列表
      • 用户图片信息审核(内容检测&人脸检测)
      • 发起作画任务
      • 作画任务信息查询
      • 超分作画任务(目前默认超分到六寸)
      • 超分作画任务查询
  1. API接入指南

API对接

对接流程#

1
开通商户
联系无界商务人员,由无界魔镜管理员在魔镜后台开通商户。
2
购买作画张数
魔镜API商户需线下和商务对接进行充值,购买作画张数以及模版,由管理员在魔镜后台分配张数和模版。
3
调试API鉴权
开通成功后,用户登陆 魔镜后台 获取密钥,通过密钥调通API鉴权流程,详见下方Demo。
4
接入作画API
5
接入API时的问题反馈
API接入遇到问题时,建议优先向我们反馈响应Header中的TRACE_ID以快速定位问题。API异常码见文末列表。

签名流程#

image.png

签名步骤#

平台提供appid和公私钥,API接入方根据这个信息先完成鉴权签名流程,每个API的请求头都需要加上。
可参考下方签名代码demo。
签名失效时间为5分钟。
1
创建签名
创建签名原文{"appId":"appId","timestamp":当前时间戳} (字段按字母顺序排序),使用私钥进行 SHA256withRSA 签名,再进行Base64处理。
2
签名加到请求头,发起API请求
在Request Header中的添加 Authorization 字段,字段值格式为
{"secretKeyVersion":"1","appId":"你的appid","sign":"签名sign", "original": "签名原文"}
3
发起API请求
API鉴权成功,Http状态码会返回200
签名代码Demo
Demo见此链接
go-sdk
接口请求前缀地址
https://gate.wujieai.net/wj-open/v1

Http状态码#

状态码描述
400参数不合法
401权限不足
403签名鉴权不通过
405请求方式错误
429请求API限流
415传参的资源类型错误,需正确设置content-type:application/json

业务响应报文#

业务返回值http状态码都是200,业务异常在body下面的code上标识
正常
异常
非法参数
{
    "code": "200",
    "data": {
    		//数据
    },
    "message": "success",
    "success": true
}

回调机制#

部分异步任务接口,在提交请求时,若填写notify_url字段,则在任务完成时,会将结果信息送往此地址。
具体回调内容,见各接口文档。

回调重试规则#

1.
支持5级重试时间: 5, 10, 30, 60, 120 (单位:秒),也就是分别会在5s、10s、30s...时进行回调重试
2.
当回调通知方返回success时,我们会认为您已经成功处理回调,并终止重试

回调验签#

1.
从 Headers 的 Authorization 字段中获取签名原文original和签名后的字符串sign
2.
使用公钥验签,方法同上
MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJxv9d5dRpaW7sB16Rx6OtIw7AaWj4JUslPYM4JVEfZDWni1MjjU7LGnToYmUkgxlP2SACCVxLyHVm40kM1DGUcCAwEAAQ==
注:回调场景必须使用该公钥验签!

异常码#

异常码描述
21060002作画剩余张数不足
上一页
操作示例
下一页
作画出图速度
Built with