SDK 手册

> 简化易企用开放能力，提升集成效率

# 1. 设计原则
- 少依赖 - 尽可能不引入第三方依赖，降低使用成本；
- 可扩展 - 可按需使用，可方便替换自有组件如缓存等；

# 2. 能力说明
 1. 封装了集成过程中如加解密等常用工具类代码，可以直接使用，跳过不必要的调试时间；
 2. 封装了易企秀常用的接口，业务领域对象，可以直接使用，降低测试成本；
 3. 提供示例代码，方便快速直观了解易企秀开放能力，5 分钟内完成集成测试～

# 3. SDK使用说明
### 代码地址
https://gitee.com/eqxiu-ee/ecmp-open-sdk

###  快速开始
1. 开通账号
2. 配置密钥
3. 添加 sdk 依赖
4. 创建对应模块的实例并调用需要的方法

### 目录结构
cn/eqxiu/open/
├── common/                 # 通用包装类
├── domain/                  # 领域模型
│   ├── type/                # 枚举和类型
│   └── event/             # 事件相关
├── service/                  # 服务层
├── support/                 # 支持类
└── util/                      # 工具类

### 业务封装接口

| 接口封装类                     | 说明               |
|---------------------------|------------------|
| ConnectService            | 易企秀连接服务,单点登录使用该类 |
| CorpService               | 企业相关接口           |
| CreationService           | 作品相关接口           |
| TemplateService           | 模板相关接口           |
| GroupService              | 模板/素材分组接口        |
| CreationDistributeService | 作品分发接口           |
| CreationShareService      | 作品共享接口           |
| BlackListService          | 活动黑名单接口          |
| FormService               | 表单接口             |
| IntegrateService          | 集成配置管理接口         |
| ProductService            | 平台集成接口，管理子企业使用该类 |

# 4. 集成示例代码
## 代码地址
https://gitee.com/eqxiu-ee/ecmp-open-sample

## 功能说明
1. 该代码为基于 SDK 对接使用示例；
2. 提供了web模式，用于演示单点登录场景，事件回调等场景；
3. 提供了main方法控制台启动模式，用于演示主动调用 API 类场景；

## 使用说明

1. 已经有了正式或试用账号
2. 在控制台-密钥管理中配置好请求密钥与回调密钥
3. 在本项目 application.yaml 中或启动参参数中配置密钥

### http接口示例

1. 在本项目 application.yaml 中或启动参参数中配置密钥

```
-Deqxiu.secretId=xxx -Deqxiu.secretKey=xxx -Deqxiu.signatureKey=xxx -Deqxiu.encodingKey=xxx
```

2. 启动项目 EcmpSampleApplication
3. 使用DataReceiveController 配合Mock 系统测试事件推送 https://mock.yqh5.cn
4. EcmpSSOController 为单点登录代码示例

### API使用示例

1. 企业接口示例 PullDataSample
2. 平台型接口示例 ProductAPISample
3. 运行时，修改代码中的密钥属性，或者添加 main 方法参数

```
    //密钥参数需要替换成实际的密钥参数
    String secretId = null;
    String secretKey = null;
```