云服务API集成,由于涉及到签名算法,建议伙伴在自己的后台server调用小鱼云服务API。集成封装成伙伴自己的API接口,再提供给己方客户端调用。 小鱼云服务能力提供了以下两种集成方式
伙伴可以在任何支持http请求的平台调用API,如Java、C#、Delphi等。只要按照云服务API的要求计算签名,完成请求交互,即可集成小鱼公开服务能力。
此方式较灵活,推荐使用该方式集成。
为了简化计算签名操作,方便伙伴更快捷的在Java环境集成小鱼服务能力,云服务API也支持下载使用jar依赖集成。 注意:如果私有环境使用 Java SDK 集成,需要调用先初始化私有服务地址,替换jar默认的公有服务地址。
//调用API接口前进行初始化
SDKConfigMgr sdkConfig = new SDKConfigMgr();
sdkConfig.setServerHost("私有服务地址如 https://xxx")
小鱼服务会对每个API访问请求进行签名鉴权保障安全性。
建议伙伴在集成的时候,根据实际场景,合理请求,避免触发限流。
REST FUL API 中的 {version} 为Path动态参数,用来区分API版本号。无特殊标明指定版本号的情况下,版本号为v1,即把{version}替换为v1即可。
小鱼目前给第三方使用客户提供公有云,3.9,5.2,6.0四套主要的使用环境,部分接口在不同的环境里具备不同的参数。其中该文档对齐小鱼公有云环境的所有接口,所有文档中包含的参数都在小鱼公有云环境中生效;对于小鱼私有云和分区云环境,每个api文档用【初始平台】加以描述,按发布时间顺序标注(即3.9包含的参数,5.2和6.0一定有;5.2包含的参数,6.0一定有)。
企业可以开启企业级的传输加密开关,从而提升数据的安全性 企业管理员可使用对应的管理员账号登录云视讯管理平台,通过“系统服务 – 云视讯 API - 基本信息” 中的 "数据加密传输" 选项中进行配置 支持SM4、AES128、AES256加密算法,配置算法并开启企业加密开关后会生成秘钥 开启API数据加密传输后发送请求的body要通过上一步获取的秘钥进行加密,返回的结果要通过上一步获取的秘钥进行解密,加强数据安全性(详细加解密方式可在“系统服务 – 云视讯 API - 基本信息” 中的 "数据加密传输"中下载到使用说明书)
注:如果开启API数据加密传输需要先加密后计算签名