开放平台须知
GET
/
开放平台
最后修改时间:2023-07-03 02:38:22
1.概述
2.接入流程
key:一般为企业编码
secret:企业开放平台秘钥
route:企业接口首级路径
3.如何请求接口
分为两步:(posman示例)
1)获取身份凭证
通过/sign接口GET方式传入key、secret获得身份凭证Authorization(返回的body内容)
身份凭证有效期为24小时,请缓存复 用。新请求生成新的凭证,频繁请求该接口会导致拦截。
POST请求方式,在接口加入首级路径route,固定参数version=1,设置请求头Authorization。
一般有两种请求形式application/json、application/x-www-form-urlencoded,请根据文档描述或者演示代码判断。
如果是application/json,不需要参数值时也需要传入空对象,否则接口可能会返回404。
返回接口在http状态码为200的情况下,返回值body为UTF-8编码,JSON格式。
如:
{
"status": 0, // 状态码。0表示执行成功,否则表示错误码
"message":"",// 当status=0 时为”“或无此字段。否则表示错误消息
"data": object // 表示实际的请求结果。当status=0 时必填
)
4.接口频率
请求参数
Query 参数
version
string
可选
默认值:
1
Header 参数
token
string
可选
默认值:
eyJhbGciOiJIUzUxMiJ9.eyJ4ZXRVc2VySWQiOiJ1X3Nka182Mzg0NjgzZDAyYmEyX2xlZkFuNWFqZVMiLCJzdWIiOiJjaGF5dXwxMDAwMXwxIiwiZW1wbG95ZWVOYW1lIjoi57O757uf566h55CG5ZGYMSIsImRpbmd0YWxrQ29ycElkIjpudWxsLCJ3ZUNoYXRVc2VySWQiOm51bGwsImNyZWF0ZWQiOjE3NDg0ODQ2MDY3ODMsInJvbGVzIjpbMV0sImVtcGxveWVlSWQiOjEwMDAxLCJlbnQiOiJjaGF5dSIsImlzR3JleSI6ZmFsc2UsImF1dGhvcml0aWVzIjpbeyJhdXRob3JpdHkiOiJCQVNFIn1dLCJ4ZXRTZGtVc2VySWQiOiIiLCJlbXBsb3llZUNvZGUiOiIxMDAwMSIsImlzU3RvcmVFbXBsb3llZSI6MCwiZGluZ1VzZXJJZCI6bnVsbCwicGFzc3dvcmQiOiJmZjllNzk5ZTM1MjZjYmEwNjI3NTJjMjM0ODIxM2MxYyIsIndlQ2hhdENvcnBJZCI6bnVsbCwib3JnYW5pemF0aW9ucyI6WzFdLCJjdXJyZW50Um9sZSI6MSwiY3VycmVudE9yZ2FuaXphdGlvbiI6MSwiZXhwIjoxNzQ4NTcxMDA2fQ.q8rVGN8tirzX1t02F10mXcS5jkKLUzdBCoCSReY-IpWPeIahGoc68opecNPcfo1G0amFNzJ1pSFhFpKgvTVPxQ
ent
string
可选
默认值:
{{ent}}
Content-Type
string
可选
默认值:
application/json