31api中心是用于帮助开发者集成我们31会议的api接口,进行api开发
各个调用的api的host列表见下表:
Host | 说明 | 测试环境Host | 生产环境Host |
---|---|---|---|
Oauth | SSO认证与Token颁发 | https://test2-oauth.31huiyi.com | https://oauth.31huiyi.com/ |
OpenAPI | 31OpenAPI | https://test2-31api.31huiyi.com | https://31api.31huiyi.com |
Conf | 前端登录 | https://test2-conf.31huiyi.com | https://conf.31huiyi.com |
sso是基于outh2.0协议进行开发的,需要在对接的时候查看文档说明里面是否需要授权权限,需要授权权限则说明需要进行授权传递参数,不需要则说明不需要sso的相关信息
每个访问的客户端联系31的对接服务人员后,会获得唯一的客户端Id与对应的密钥。
要使用31OpenAPI,首先需要访问connect/token,填入对应的appKey(客户端Id)与appSecret(密钥),之后就能获得登录的token与用来刷新token的refreshToken。
Path: /connect/token
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
grant_type | string | 必须 | 授权类型(默认值:custom_user_code) | ||
client_id | string | 必须 | 客户端(默认值:openapi) | ||
scope | string | 必须 | 授权范围(默认值:offline_access OpenAppGateway) | ||
method | string | 必须 | 自定义登录方式(默认值:client_secret) | ||
appKey | string | 必须 | 颁发的appkey | ||
appSecret | string | 必须 | 颁发的appsecret |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
access_token | string | 必须 | |||
expires_in | number | 必须 | 过期时间 | ||
token_type | string | 必须 | token类型(Bearer) | ||
refresh_token | string | 必须 | 刷新token | ||
scope | string | 必须 | 授权范围 |
Path: /connect/token
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
grant_type | string | 必须 | 授权类型(默认值:refresh_token) | ||
client_id | string | 必须 | 客户端 | ||
refresh_token | string | 必须 | 刷新token |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
access_token | string | 必须 | |||
expires_in | number | 必须 | 过期时间 | ||
token_type | string | 必须 | token类型(Bearer) | ||
refresh_token | string | 必须 | 刷新token | ||
scope | string | 必须 | 授权范围 |
获取访问Token之后,可以用这个Token进行业务API的调用。
Token目前是Bearer的格式,放在请求头的Authorization内进行传输与认证。
Token过期时间是5分钟,RefreshToken的过期时间是2小时。