# 请求简介
开放平台的API是基于HTTP协议来调用的,开发者可以直接使用开放平台的协议来封装HTTP请求进行调用, 以下主要是针对自行封装HTTP请求进行API调用的原理进行详细解说。
开放平台OAuth2.0接入 采用授权码模式
, 具体OAuth2.0文档可参考(https://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html)
Authorization Code 授权分为两步,
首先获取Authorization Code,然后用Code换取Access Token.其流程示意图如上,
步骤(A)、(B)和(C)的直线因为通过User-Agent而被分为两部分.具体流程解释可参考FRC文档 (opens new window)。
# 请求地址
调用API的服务URL地址, 开放平台目前提供如下环境供使用:
环境 | https地址 |
---|---|
正式环境 | https://openapi.smzdm.com |
# 公共参数
调用任何一个API都必须传入的参数, 目前支持的公共参数有:
参数名称 | 参数类型 | 是否必须 | 参数描述 |
---|---|---|---|
app_key | String | 是 | 开放平台分配给应用的AppKey。例:12345678 |
# 调用示例
# 一、参数示例
array (
'app_key' =>'123456789',
)
1
2
3
2
3
# 注意事项
- 该文档仅适用OAuah2.0方式接入的接口调用方式
# 常见平台级错误码
错误码 | 错误信息 | 错误原因 | 解决方案 |
---|---|---|---|
100070 | String | 开放平台提供的接口不合法 | 联系开放平台对接人员 |
100071 | String | 接口未授权或已下架 | 联系开放平台对接人员 |
100072 | String | 请求Method不合法 | 重新查看文档,确认请求是GET,还是POST请求 |
100078 | String | 触发限流规则 | 联系开放平台对接人员 |
100080 | String | 接口未授权 | 联系开放平台对接人员 |
100110 | String | 数据解析错误 | 联系开放平台对接人员 |
100111 | String | 缺少app_key参数 | 重新查询传参 |
100112 | String | 数据解析错误 | 联系开放平台对接人员 |
100113 | String | 密钥配置错误 | 联系开放平台对接人员 |
100114 | String | sign或者time字段为空 | 重新查询传参 |
100115 | String | timestamp字段不合法 | 重新查询传参 |
100116 | String | timestamp字段不合法 | 重新查询传参 |
100120 | String | timestamp字段过期 | 重新查询传参 |
100130 | String | 签名校验失败 | 重新查询传参 |