SSO

公共信息

通用性错误

名称	类型	默认值	是否必须	说明	备注
success	boolean		必须	请求状态
data	object		非必须	请求内容
errorCode	string		非必须	异常编码
errorMessage	string		非必须	异常内容
showType	integer		非必须	前端动作
traceId	string		必须	追踪ID

{
  "success": false,
  "data": "string",
  "errorCode": "S_SERVE_FORBIDDEN",
  "errorMessage": "用户未得到授权，访问是被禁止的",
  "showType": 1,
  "traceId": "e59e6f078389d36c2bb06d29297b5b86"
}

前端动作类型， 页面的内容应该有前端拦截器统一处理

名称	类型	值	动作	备注
ShowNone		0	静音
ShowWarn		1	消息警告
ShowError		2	消息错误
ShowNotify		4	通知
ShowPage		9	页面跳转

SSO服务器

测试服务器：https://api.dev1.sims-cn.com
正式服务器：https://api.sdk.plscn.com

备注

插件安装： https://microsoftedge.microsoft.com/addons/detail/crossrequest/bephiepmhphdlafkfonngafenjhfehlb

公共分类

获取访问令牌（平台访问令牌）

基本信息

Path： /v1/sdk/token/access_token

Method： GET

接口描述：

访问令牌，为第三方应用访问平台资源提供验证方式。令牌一旦签发，7200有效，不可注销。令牌权限等同签发令牌用户的权限。具有可选的用户，租户，应用，角色等信息。同一用户可以同时具有多个访问令牌。

请求参数

Query

参数名称	是否必须	示例	备注
appid	是	AciejDxueDsudrT	应用ID
secret	是	123456	应用密钥

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ access_token	string	非必须
├─ expires_in	number	非必须
├─ expired_at	number	非必须
traceId	string	非必须

获取访问令牌（访问租户应用）

基本信息

Path： /v1/sdk/token/agent_token

Method： GET

接口描述：

应用令牌，只具有访问单个应用的所有权限。如果需要复杂的业务处理，请使用平台访问令牌。该令牌只能管理员签发和使用，需要注意的是，该令牌是应用令牌，其中不包含用户人员等信息。令牌一旦签发，不可撤销和修改。

请求参数

Query

参数名称	是否必须	示例	备注
corp	是	C34r7ABy51h8iyQuIErrdko	企业编码
agent	是	1000001	应用代理
secret	是	S69vNY0000002FnLwPA0nA8E1l8NDu2HoUt	应用密钥

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ access_token	string	非必须		访问令牌
├─ expires_in	number	非必须		过期间隔
├─ expired_at	number	非必须		过期时间
traceId	string	非必须

验证访问令牌

基本信息

Path： /v1/sdk/token/check_token

Method： GET

接口描述：

验证令牌是否有效和是否过期

请求参数

Query

参数名称	是否必须	示例	备注
access_token	是		令牌

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
data	object	非必须
├─ effective	boolean	非必须		有效
├─ expired_at	number	非必须		过期时间
traceId	string	非必须