| 内容 | 说明 |
|---|---|
| 传输方式 | http[s] (为提高安全性,强烈推荐https) |
| 请求地址 | http[s]: //api.xf-yun.com/v1/private/sff4ea3cf 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
| 请求方式 | POST |
| 接口鉴权 | 签名机制,详情请参照下方鉴权认证 |
| 字符编码 | UTF-8 |
| 响应格式 | 统一采用JSON格式 |
| 开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
| 适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器 |
| 图片格式 | jpg/jpeg/png/bmp |
| 图片大小 | base64编码后大小不超过4M |
http://api.xf-yun.com/v1/private/sff4ea3cf?authorization=YXBpX2tleT0iOTEyMDVhZmUwZDE3ZTM4YzYxYmUzNWZjYTM0NjUwM2MiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iOU1WYktFMndUWjJmS1A5NzdvbkpFSjBLT3d2Mk1WQ3lybnIydjY4YzNWZz0i&host=api.xf-yun.com%3A-1&date=Tue%2C+24+Nov+2020+03%3A28%3A17+GMT| 参数 | 类型 | 必须 | 说明 | 示例 |
|---|---|---|---|---|
| host | string | 是 | 请求主机 | api.xf-yun.com |
| date | string | 是 | 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") | Fri, 17 Jul 2020 06:26:58 GMT |
| authorization | string | 是 | 使用base64编码的签名相关信息(签名基于hamc-sha256计算) | 参考下方详细生成规则 |
api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"host: $host\ndate: $date\n$request-line请求url = api.xf-yun.com
date = Fri, 17 Jul 2020 06:26:58 GMThost: api.xf-yun.com
date: Fri, 17 Jul 2020 06:26:58 GMT
POST /v1/private/sff4ea3cf HTTP/1.1signature_sha=hmac-sha256(signature_origin,$apiSecret)signature=base64(signature_sha)APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX
date = Fri, 17 Jul 2020 06:26:58 GMTsignature=RkxLPmQqY8qkl/rvXb5T3oMbY9BhtAv5emCE4SfQy6o=api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="RkxLPmQqY8qkl/rvXb5T3oMbY9BhtAv5emCE4SfQy6o="authorization = base64(authorization_origin)
示例:
authorization=YXBpX2tleT0iOTEyMDVhZmUwZDE3ZTM4YzYxYmUzNWZjYTM0NjUwM2MiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iUmt4TFBtUXFZOHFrbC9ydlhiNVQzb01iWTlCaHRBdjVlbUNFNFNmUXk2bz0| HTTP Code | 说明 | 错误描述信息 | 解决方法 |
|---|---|---|---|
| 401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
| 401 | 签名参数解析失败 | {“message”:”HMAC signature cannot be verified”} |