iSolarCloud开放API调用-帮助文档-V2.0.2(1).pdfVIP

iSolarCloud 开放API 调用-帮助文档 说明： 1、本文档截图中的API 调用地址不是最终调用地址，请务必以最终提供的API 调用授 权说明书上的API 调用地址为准。 调用API 的前提条件： 已经获取到阳光电源股份有限公司提供的API 调用授权文档上的用户账号、用户密码、 appkey、API 调用地址、API 文档、测点文档等： API 调用地址说明： API 定义文档中每个接口的服务地址中的 https://此处为阳光电源提供的 API 域名部 分请换成阳光电源提供的对应环境的API 域名： 中国站：/ 国际站：.hk/ 欧洲站：https://gateway.isolarcloud.eu/ 然后根据API 文档里面接口出入参定义，进行调用登录 （login）接口: 说明：登录接口主要是根据授权书上提供的用户账号和用户密码进行登录，登录成功后， 出参会返回这个用户的user_id 和token，记住这个用户的user_id 和用户本次登录生成的 token,后续调用其他接口需要用到这2 个信息。 其中每次调用登录接口生成的用户token 的有效期为24 小时，如果24 小时内使用该token 调用了任意接口，该token 的有效期会自动恢复为24 小时，所以每次访问其它接口时无需 再次调用登录接口获取新的token,仅在token 失效了才需要调用登录接口获取token。 调用样例 （参考API 文档上的样例）： 获取用户下的电站列表，请调用电站列表（getPsList）接口： 该接口的入参的user_id 就是登录接口 login返回的user_id. 调用样例 （参考API 文档上的样例）： 这个接口返回了这个用户下的电站列表，如上图。该接口的出参中含有电站的 ps_id, 后续获取这个电站下的设备和设备数据需要用到这个电站的ps_id. 我们以上述接口返回的某个电站 ps_id 为例，调用 getDeviceList 接口获取这个电站 下的设备列表信息： 调用样例 （参考API 文档上的样例）： 以上出参，返回的参数样例如下： 出参中有每个设备的ps_key，如果当前是逆变器设备，那么这个ps_key 就是逆变器设 备的ps_key,这个ps_key 在调用接口queryDevicePointMinuteDataList 获取设备测点数据 的时候需要。 也可以通过接口queryDeviceListByUserId查询用户下某个电站ps_id下指定类型设备 的设备列表： 调用样例 （参考API 文档上的样例）： 其中入参中的device_type表示设备类型，如1表示逆变器，11表示电站，具体请参考API 文档附录中的设备类型说明： 通过调用queryDevicePointMinuteDataList接口获取设备的分钟数据： 如果要获取电站的数据，电站的ps_key为电站ps_id_11_0_0，如电站的ps_id为10，那 么电站的ps_key为10_11_0_0，可以通过调用设备列表接口获取设备的ps_key。 如获取逆变器设备的分钟数据，传入该台逆变器的ps_key，points这个参数是要查询的 那个测点id,如光伏逆变器日发电量测点p1，光伏逆变器累计发电量测点p2，具体测点请通 过调用getOpenPointInfo接口进行获取： queryDevicePointMinuteDataList接口调用样例 （参考API文档上的样例）： 说明：如果当前查询的设备的某个测点没有数据，那么接口不会返回这个测点。 如果想看某个电站的基本信息，如电站名称，经纬度等信息，可以调用接口 getPowerStationForHousehold进行查询： 调用样例 （参考API文档上的样例）： 光伏逆变器的实时数据可以通过接口queryDeviceRealTimeDataByPsKeys （只支持光伏 逆变器）进行获取，传入设备的ps_key集合进行查询： 调用样例 （参考API文档上的样例）：