内容中台技术手册
动态与公告
公告
发布记录
接口变更记录
对接必读
产品简介
名词解释
调用方式
公共代码
公共事件
账号开通
基础集成
单点登录
访客体系打通
数据推送
授权接口
管理集成
组织模型
企业配置接口
员工管理接口
集成配置接口
部门管理接口
编辑器集成
通用
集成页面
作品接口
统计数据接口
行为画像接口
传播脉络接口
模板接口
素材接口
分组接口
多人分发接口
作品共享接口
编辑器公共事件
黑名单管理
访客信息接口
互动
互动接口
活动参与信息接口
互动事件
自定义活动逻辑(抽奖等)
积分、权益体系集成
奖品库集成
互动任务
电子兑奖码
互动活动配置同步
地址库对接
活动白名单
收货地址自定义提交
表单
自定义表单提交
表单默认值自动填充
表单回传数据
表单选项数据结构
嵌入第三方页面
表单接口
H5
自定义下拉表单组件
任务组件
动态替换作品元素
H5接口
任务组件(新)
自定义js脚本(新)
渲染组件相关接口
数据集成
H5事件
留资玩法
长页
海报
基于模板生成图片
对接素材美化和编辑功能
海报事件
视频
服务集成
短信服务集成
素材库集成接口
自定义JS集成
审批工作流集成
红包服务集成
收款配置-小程序对接
移动端集成
Android SDK集成
iOS SDK集成
平台集成
集成申请
用户组织架构
平台接口
配置指南
企业配置
集成配置
商户号配置
最佳实践
年度总结H5
微信小程序嵌入H5
支付宝小程序嵌入H5
基于模板动态生成图片
跳转小程序页面
PC大转盘抽奖使用方法
私域分享增加权益
微信小程序对接互动默认商户号红包
常见问题
-
+
授权接口
## 获取令牌(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 | 请求签名(根据签名算法计算得出)[生成签名示例](https://hc.eqxiu.cn/doc/17/) | - 返回值示例 ```json { "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 | 内容平台后端交互令牌 | - 返回值示例 ```json { "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 | - 返回值示例 ```json { 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 | 内容平台后端交互令牌 | - 返回值 ```json { success:true, code:"200", obj:null } ```
will
May 31, 2023, 1:27 p.m.
7265
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码