前置条件
> 对接方提供接收数据的HTTP协议(POST请求,Content-Type: application/json)的完整接口地址,并由乐陪分配密钥与授权数据模块,授权的数据模块均通过对接方提供的接口地址推送。
>
> 接口交互的数据会经过加密处理,获取实际数据需解密,处理后需返回处理结果,且接口请求需在5秒内响应,超时即失败。
>
> 通过调用乐陪方接口,乐陪系统开始自动推送数据。
**对接流程**
![image.png](https://cos.easydoc.net/32050984/files/lgvwu6au.png)
**对接前乐陪提供**
| 字段名称 | 字段类型 | 字段描述 |
| ----------- | -------- | :---------------------------------- |
| schoolId | string | 乐陪的学校ID |
| appId | string | 乐陪生成的APPID |
| secretKey | string | 乐陪生成的密钥 |
**对接前对接方提供**
> HTTP协议post方式,Content-Type为application/json的完整接口地址,且按要求响应回复。
**接口响应回复参数**
```json
{
"code":200,
"message":"success"
}
说明:正常情况下返回的成功json串,code为200即成功,非200即失败。
```
**数据模块**
> 数据模块,用来区分不同的数据,由对接方提出数据需求,乐陪方授权后提供,并更新接口文档。
>
> 数据模块可分多次授权,新产生的授权后对接方需对数据模块做一次全量同步,方可开启新授权模块的增量同步。
>
> 如果数据模块存在关联,不建议使用物理主外键做全量同步,使用逻辑外键。