锦浪云平台API说明文档
1.整体介绍
锦浪为方便第三方平台获取数据和控制设备,提供了两种方便快捷的 API 接口方案。分别是:
- API 获取单账号权限,适用于客户自有监控平台的接入场景。
- API 获取多账号权限,适用于第三方业务平台的接入场景,如第三方监控平台、VPP 平台。
本文档介绍了两个 API 方案的接入流程,用户可根据自身需求选择相关的方案。
2.API 获取单账号权限
2.1 应用场景
在自有监控平台接入场景下,即单一业主/安装商想通过 API 监控自己账号下的电站设备数据, 可根据 2.2 开通单一账号的 API。
2.2 API 开通流程
- 向锦浪售后或销售提供锦浪云账号,申请 API 开通权限。
- 权限开通后,登录锦浪云 WEB 端( https://www.ginlongcloud.com/ ),点击【服务】-【API 管理】。
注:开通 API 权限后,需要退出重新登录
- 点击【立即开通】,验证身份后即可查看 KeyID 和 KeySecret。
- API 文档可点击黄色字体 “锦浪云 API 接入文档” 查看。
3.API 获取多账号权限
3.1 应用场景
锦浪云 API 用户身份鉴权采用 OAuth2.0。在第三方业务平台接入场景下,第三方应用需要访问 用户在锦浪云的数据,需要用户授权给第三方应用访问权限,锦浪云对用户身份认证后根据用户选 择的授权范围给到第三方数据。
3.2 第三方应用接入
- 第三方需已与锦浪达成合作协议,下载并填写附录中的“锦浪云 API 激活申请材料”,并 将表格发送给锦浪团队;
- 在锦浪资质审核完成后,锦浪会通过“锦浪云 API 激活申请材料”中的邮箱提供 OAuth2.0 接入文档及 AppKey、AppSecret;
- 第三方根据 OAuth2.0 接入文档完成接入。
3.3 用户授权流程
- 用户在第三方应用发起数据授权后,会跳转到锦浪云的登录页面。
- 用户登录锦浪云并选择授权范围。
- 同意后,用户将被重定向回第三方应用提供的回调地址,完成授权操作。