睿智云社区第三方API对接开放协议

作者	版本	说明
姜鹏	V1.1	API初版
	V1.2	调整生产域名

适用范围：外部平台对接社区平台产品。

1 API 安全规范

任何调用开放平台的请求，须按《2.3 API 安全》规定在http头部携带thirdAuth标识。

2 全局约定

2.1 域名

环境	域名	说明
测试	https://biz-admin-sit.smartmideazy.com
生产	https://biz-admin.remacsmart.com

2.2 接口响应约定

响应格式

正确响应：

 {
    "code": "200",
    "message":"success",
    "result": {

           .... 
    }

 }

错误响应：

 {
    "code": "非200",
    "message":"错误提示"


 }

2.3 API 安全

任何第三方平台调用睿智云平台API均须携带头部 thirdAuth标识。

HTTP头部名称：thirdAuth，值：从接口《3.1 获取授权凭证接口》或《3.2 刷新授权凭证接口》获取的access_token值。

3 接口约定

3.1 获取授权凭证接口

说明：此接口当天最大调用次数为24次，请获取access_token后妥善保存。

协议：HTTP

URL： /v1/oauth/third/token

方法： POST

请求示例：

{"client_id": "睿智云平台CLIENT_ID",  "client_secret":"睿智云平台CLIENT_SECRET", "grant_type":"password"}

请求属性

字段	类型	说明
client_id	String	由睿智云平台统一颁发客户端ID标识
client_secret	String	由睿智云平台统一颁发客户端密钥
grant_type	String	固定password

正确返回：

{
  "result": {
    "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJwbGF0Zm9ybV90aWNrZXQiLCJqdGkiOiIwZDg2NjRjYy02NzExLTQ1NmQtOWYyOC1iZGNkM2M0MzNhMzgiLCJ1c2VyX25hbWUiOiJndnNzb3VuZCIsIm5hbWUiOiJndnNzb3VuZCIsImlzcyI6InJlbWFjIiwiaWF0IjoxNjU0MDQ1OTQ5LCJleHAiOjE2NTQwNTMxNDl9.DnO-NeJ94M_c1D2tx02khZm2h-SSeM2YGp6kU2bKNpkzT4uszcIOTgfw37VF-SaZ5juI5-seiA6VvqfzJqO1eMd8LvHccOUn0Gg_J0ex-8SaqBSsJXr8kOKP71oL8hU0QAghg0aZNeMqoFQwwBBPq1SbWQ5gJIqgJPCL0lZ66kk",
    "token_type": "bearer",
    "refresh_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJwbGF0Zm9ybV90aWNrZXQiLCJqdGkiOiIwZDg2NjRjYy02NzExLTQ1NmQtOWYyOC1iZGNkM2M0MzNhMzgiLCJ1c2VyX25hbWUiOiJndnNzb3VuZCIsImF0aSI6IjBkODY2NGNjLTY3MTEtNDU2ZC05ZjI4LWJkY2QzYzQzM2EzOCIsIm5hbWUiOiJndnNzb3VuZCIsImlzcyI6InJlbWFjIiwiaWF0IjoxNjU0MDQ1OTQ5LCJleHAiOjE2NTQwODE5NDl9.qcZxyAQdB6m-qUcKawOrgTiye8bWDmYP3Dsfw0piX2MlaS9JtPwDaVCtv8Xg1GBRHzrqW7rl1CMICKW7TPdzQqTKN0kQtHhMaNlalZrulsR69GB4NqSPUgDGNoYrEVqcMuet5F0PnioSW8-6U0CxO5cBS_5EeAFQJpmo5hbESJU",
    "scope": "all",
    "jti": "0d8664cc-6711-456d-9f28-bdcd3c433a38",
    "expires_in": 7200
  },
  "code": "200",
  "message": "成功"
}

返回属性说明

字段	类型	说明
access_token	String	睿智云平台授权凭证，过期时间2小时，第三方平台访问睿智云API的唯一凭证。过期时，请拿refresh_token获取新的凭证。
refresh_token	String	睿智云平台授权刷新凭证，过期时间10小时，当access_token过期时，可以通过refresh_token获取新的凭证
expires_in	Int	从当前返回结果的时间开始，access_token有效存活的时间，单位为秒

3.2 刷新授权凭证接口