FAQ

一:接口相关

接口接入常见问题

1:加密串自查手册

⚠️注意:以下错误都可能导致接口返回401 {"message":"check signture fail"} ,不代表签名算法出错!

  • 检查URI是否正确。URI以 ”/“ 开头,并以 ”/“ 结尾,当结尾不是”/“ 需要补上”/“,如:/api/user 需要变为 /api/user/
  • 请注意没有query参数就传入空字符串,不要省略。
  • 检查URI和URL是否多了空格
  • 如果有body参数,请检查加密串内容元素依次是请求类型,uri,query参数,时间戳,body参数
  • 如果没有body参数,请检查加密串内容元素依次是请求类型,uri,query参数,时间戳
  • 请求头参数不要放在加密串
  • 检查加密体的参数顺序和请求时的body参数顺序是否一致
  • GET方式请检查调用接口时是否已把参数拼装到URL上,且参数名按 ASCII 码从小到大排序(字典序,不需要 urlEncode)

举个例子:

A:调用开放平台通用抠图接口:

【POST】https://open-api.gaoding.com/api/call/mattingcommon

传入的参数:

header参数:app_id=AAA01

body参数:{"url":"http://xxx.com/a.jpg"}

正确的加密体

POST@/api/call/mattingcommon/@@1644567624@{"url":"http://xxx.com/a.jpg"}

错误的加密体:

  • POST@/api/call/mattingcommon@@1644567624@{"url":"http://xxx.com/a.jpg"} -- URI缺少/结尾
  • POST@/api/call/mattingcommon/@1644567624@{"url":"http://xxx.com/a.jpg"} -- 没传query参数,没有query参数请传空字符串
  • POST@/api/call/mattingcommon/@{app_id=AAA01}@1644567624@{"url":"http://xxx.com/a.jpg"} -- 不能把header参数放在加密体里


B:调用开放平台获取授权码接口:

【GET】https://open-api.gaoding.com/api/authorized/code

传入的参数:

query参数:app_id=AAA01&uid=123456

正确的加密体

GET@/api/authorized/code/@app_id=AAA01&uid=123456@1644568171

错误的加密体

  • GET@/api/authorized/code/@app_id=AAA01&uid=123456@1644568171@{} -- 没有body参数不需要传
  • GET@/api/authorized/code/@app_id=AAA01&uid=123456@1644568171@ -- 结尾不要有@
  • GET@/api/authorized/code/@1644568171@app_id=AAA01&uid=123456 -- 加密体元素顺序错误

2:postman调试接口返回401

A:请特别注意请求body不要有空格

错误的例子

正确的例子



能力使用常见问题

1:证件照尺寸是否可扩充

A: 证件照抠图的width和height参数可自定义,最大可支持3000*3000,接口文档中的尺寸仅提供参考和快速查阅

2:证件照抠图接口部分参数未生效

A:当background入参是:transparent时,file_tpye不生效始终为png

图片类型本身的限制,jpg不支持透明背景


B:当file_type入参是:png时, quality不生效

A:图片类型本身的限制,png不能压缩

3:抠图相关接口超时

A:图片太大了,建议图片大小在3000*3000以内

4:应用产品未关联

A:接口返回:{"code":"403","message":"应用产品未关联"},需要在应用里添加产品或API

操作路径:控制台-我的应用-应用详情-产品管理-添加产品 / 控制台-我的应用-应用详情-产品管理-关联API




二:编辑器相关

1:高级版编辑器获取token失败

A: 请注意传入SDK的授权码只要value即可,不需要整个JSON串


B:授权码是临时的,用过就会销毁,请注意编辑器每次在获取token时需要重新生成授权码



2:编辑器上传图片返回403

A:SDK版本过低,请确保使用1.2.2+ 版本


3:get请求/utm-editors/xx 报404,如下图

A:SDK版本过低,请确保使用1.2.2+ 版本