科达视讯平台统一登录API

V6.1.0.4.0.20201230

API_Level:3

名称 token获取
URI /api/v1/system/token
方法 POST
说明 token获取
最低支持版本 1

参数说明

参数名称 数据类型 说明
oauth_consumer_key* str oauth中认证的软件key
oauth_consumer_secret* str oauth中认证软件key对应的value

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
account_token str token,应用权限

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 保持token心跳
URI /api/v1/system/token/{account_token}/heartbeat
方法 POST
说明 获取token成功后,token有效期为30m,若30m内无操作,则需手动调用该接口保持心跳
最低支持版本 1

参数说明

null

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 登陆
URI /api/v1/system/login
方法 POST
说明 登陆
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 软件权限token
username* str 用户名
password* str 密码

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
username str 登陆的用户名
userdomainname str 用户域名称
userdomainmoid str 用户域moid
usermoid str 账号moid

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 保持用户心跳
URI /api/v1/system/heartbeat
方法 POST
说明 成功登陆后,用户有效期为30m,若30m内无操作,则需手动调用该接口保持心跳
最低支持版本 1

参数说明

参数名称 数据类型 说明
account_token* str 登陆token

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 错误码

名称 登录认证API版本信息
URI /api/system/version
方法 GET
说明 获取登录认证API版本信息
最低支持版本 1

成功回复示例

成功回复说明

参数名称 数据类型 说明
success int 是否成功
version str 版本信息
api_level int 登录API版本标识,请与登录API说明文档中的各个接口的最低支持版本号作对比,若小于最低支持版本号,则该接口不支持当前版本的API调用

失败回复示例

失败回复说明

参数名称 数据类型 说明
success int 是否成功
error_code int 失败时的错误号