授权接口

获取令牌(Token)接口

接口对接注意：

1、该接口限制最高调用次数为200次/2小时，超过后无法获取，并且在2小时内会限制调用
2、响应的数据有效期为2小时。
3、每次重新获取，上一个token不会立马失效，在5分钟内，新老token都可用
4、该接口调用时，建议单服务定时调用，统一一处缓存

接口描述：用于生成服务端请求动态凭证，所有服务端请求都必须有token参数。
接口地址：/api/v1/base/oauth/token
方法类型：POST
传参方式：url传参或使用x-www-form-urlencoded形式的body参数，不支持form-data

接口入参：

参数名	是否必须	参数类型	参数说明
secretId	必须	String	标识身份一个 SecretId 对应唯一的 SecretKey ，SecretKey 会用来生成请求签名 Signature
type	必须	String	默认为 Server
timestamp	必须	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒，5分钟内有效，例如1620626322562
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法），如果参与签名需要传此参数
signature	必须	String	请求签名（根据签名算法计算得出）生成签名示例

返回值示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": {
      "expires": 7200,
      "corpId": "b45570f23e6647b69e0fcb4372534738",
      "type": "Server",
      "token": "ed012f68a27344c9b33af13a405f5264"
  },
  "list": null
}

返回值说明

参数名	参数类型	参数说明	备注
token	String	访问token	目前有效时间为2小时，需要缓存，避免频繁调用获取 access_token 接口导致超出频率限制被拦截
expires	Long	有效期	单位：秒
type	String	token类型
corpId	String	归属公司id	此id为易企秀的公司id

登录授权码接口

接口描述：用于从企业应用客户端跳转易企秀时，企业服务端到易企秀服务端获取临时通行票据。
接口地址：/api/v1/base/oauth/code?token=TOKEN
方法类型：POST
传参方式：url传参或使用x-www-form-urlencoded形式的body参数
接口入参

参数名是否必须参数类型参数说明

openId 必须 String 三方用户唯一标识

token 必须 String 内容平台后端交互令牌

返回值示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": "qeoffou3a9",
  "map": null,
  "list": null
}

返回值说明

参数名参数类型参数说明备注

obj String 访问临时Code 目前有效时间为5分钟

静默登录接口

接口对接注意:

1、返回Authorization在24小时有效，当同一openId在未失效前再次获取时，之前获取的Authorization 将会失效。所以，每次登录，需要清除单一用户的历史Authorization

接口描述：企业员工从自建系统中无感知登录到ECMP。
接口地址：/api/v1/base/oauth/login
方法类型：GET、POST

接口入参

参数名	是否必须	参数类型	参数说明
code	必须	String	三方客户端访问内容平台临时票据
redirectUrl	否	String	页面跳转URL
deptIds	否	String	初次登录时可用于指定归属部门，多个部门用英文,分割

返回值示例

{
  success:true,
  code:"200",
  obj:"32f909e22b"
}

返回值说明

参数名参数类型参数说明备注

obj 是 String 目前有效时间为24小时，用户有操作会自动续期,可用来登录编辑器(Authorization)

注意：如果redirectUrl为空，会有返回值；如果不为空，则会跳转至链接redirectUrl。

登录退出接口

接口描述：企业员工切换退出
接口地址：/api/v1/base/auth/logout?token=TOKEN
方法类型：POST
传参方式：url传参或使用x-www-form-urlencoded形式的body参数
接口入参

参数名是否必须参数类型参数说明

openId 必须 String 用户唯一标识

token 必须 String 内容平台后端交互令牌

返回值

{
  success:true,
  code:"200",
  obj:null
}

参数名	是否必须	参数类型	参数说明
openId	必须	String	三方用户唯一标识
token	必须	String	内容平台后端交互令牌