集成须知

1. 集成方式

云服务API集成，由于涉及到签名算法，建议伙伴在自己的后台server调用小鱼云服务API。集成封装成伙伴自己的API接口，再提供给己方客户端调用。 小鱼云服务能力提供了以下一种集成方式

1.1 RESTFUL API

伙伴可以在任何支持http请求的平台调用API，如Java、C#、Delphi等。只要按照云服务API的要求计算签名，完成请求交互，即可集成小鱼公开服务能力。

此方式较灵活，推荐使用该方式集成。

2. 签名鉴权

小鱼服务会对每个API访问请求进行​​签名鉴权​​保障安全性。

3. 频率限制

建议伙伴在集成的时候，根据实际场景，合理请求，避免触发限流。

1. 1. 企业整体请求总频率默认限制为：100次/秒
2. 1. 除特殊标识的API，单API默认请求频率限制为：20次/秒

4. API版本号

REST FUL API 中的 {version} 为Path动态参数，用来区分API版本号。无特殊标明指定版本号的情况下，版本号为v1，即把{version}替换为v1即可。

5. API数据加密传输

企业可以开启企业级的传输加密开关，从而提升数据的安全性 企业管理员可使用对应的管理员账号登录云视讯管理平台，通过“系统服务 – 云视讯 API - 基本信息” 中的 "数据加密传输" 选项中进行配置 支持SM4、AES128、AES256加密算法，配置算法并开启企业加密开关后会生成秘钥 开启API数据加密传输后发送请求的body要通过上一步获取的秘钥进行加密，返回的结果要通过上一步获取的秘钥进行解密，加强数据安全性(详细加解密方式可在“系统服务 – 云视讯 API - 基本信息” 中的 "数据加密传输"中下载到使用说明书)

注：如果开启API数据加密传输需要先加密后计算签名

6. 调用时序图

6.1 未开启API数据加密传输

6.2 开启API数据加密传输