入门指南
开发者平台为开发者提供了一个高效、便捷的途径来构建和整合丰富的功能和服务，用户可以根据自己的实际需要选择合适的API类型。下面的文档帮助开发者开发者理解和集成API。
1、API使用规范
本文中所列API支持明文和加密两种方式调用；加密调用方式及说明已经在本文附录中进行说明。 加密解密方式详见 附录7：加密调用API代码样例
1.1 调用步骤
调用方可以通过开发者平台，从阳光云获取需要的电站信息和设备信息等。调用方首先需要获得阳光云电站业主的授权，然后通过授权码拿到令牌，就可以通过令牌来获取已授权的电站和设备等信息了。
1.2 错误码定义
详见 附录2：API错误码定义
1.3 约束说明
（1）本文中所有接口中使用到的用户账号、appkey等相关信息全部严格按照《阳光电源iSolarCloud云平台接口开放API-授权书说明》中的规定进行调用并获取相关数据；
（2）Http请求全是以POST的方式进行；
（3）调用平台所有的服务都需要传入平台授权的appkey，对应请求体参数名称为：appkey；
（4）调用每个API都需要传入access_token进行身份的校验，对应请求头名称为：Authorization，格式为："Bearer " + access_token；
（5）以下为请求头里面的相关参数说明：
| 参数名 | 类型 | 长度 | 描述 | 是否必传 |
|---|---|---|---|---|
| 内容类型 | 细绳 | 格式：application/json;charset=UTF-8 |
是 | |
| x-访问密钥 | 细绳 | 32 | 应用申请得到的Secret Key | 是 |
| x 随机密钥 | 细绳 | 16 | 本次请求的密钥，明文长度16位，需经过RSA加密后传输， 出参使用该明文密钥进行AES解密， 加密请求时传入 如何获取 x 随机密钥 |
否 |
（6）请求体里面需要传入以下公共参数，以下公共入参在每个API定义里面不再一一列出。
| 参数名 | 类型 | 长度 | 描述 | 是否必传 |
|---|---|---|---|---|
| 应用密钥 | 细绳 | 32 | 授权码，必传 (接口给客户端系统分配的appkey)。 | 是 |
| 郎 | 细绳 | 6 | 语言（不传则默认简体中文）： 简体中文：_zh_CN 英文：_en_US 日本语：_ja_JP 西班牙语：_es_ES 德语：_de_DE 巴西葡萄牙语：_pt_BR 葡萄牙语：_pt_BR 法语：_fr_FR 意大利语：_it_IT 韩语：_ko_KR 荷兰语：_nl_NL 波兰语：_pl_PL 越南语：_vi_VN 繁体中文：_zh_TW |
否 |
（7）以下公共出参在每个API定义中不再一一列出。
| 参数名 | 类型 | 长度 | 描述 |
|---|---|---|---|
| 请求序列号 | 细绳 | 32 | 请求序列号 |
| 结果代码 | 细绳 | 11 | 错误码 |
| 结果消息 | 细绳 | 100 | 提示信息 |
| 结果数据 | 目的 | 返回数据： 支持类型：String，Map，List等，具体数据格式请参照本文对应的API出参定义，本文中定义的出参数据都在该result_data参数下 |
（8） API 域名：在调用API文档中的接口时，请选择以下阳光电源提供的对应站点的API域名：
中国站： https://gateway.isolarcloud.com/
国际站： https://gateway.isolarcloud.com.hk/
欧洲站： https://gateway.isolarcloud.eu/
澳洲站： https://augateway.isolarcloud.com/