Api 文档
公共文档大约 2 分钟约 594 字
提示
- 本平台同时支持客户方主动调用api接口来拉取数据与平台推送部分数据到客户方,推送方式见数据推送。
- Api接口文档中部分响应字段，如实际请求的返回中没有相应属性，说明该属性值为
null，在返回响应中会自动被忽略
域名及调用方法说明
接口域名
| 域名 | 说明 |
|---|---|
https://csiapi.hxsoft.net:9016 | 测试环境 |
https://sep-api.csisolar.com | 生产环境(中国站/国际站) |
https://sep-api-eu.csisolar.com | 生产环境(EMEA) |
如果在开发过程中使用本文档所提供的接口，请使用测试域名，联系阿特斯技术支持获取
appId和appSecret
调用方式
在通过调用用户接口 -> 认证获取到
accessToken后，在请求头header中添加Authorization字段，值为Bearer {token}
多语言处理
在请求参数中，如果需要支持多语言，则需要在请求头
header中添加Accept-Language参数，值为zh-CN或en-US等，目前已经支持的语言:
| 语言值 | 说明 |
|---|---|
zh-CN | 中文（简体） |
en-US | 英语（美国） |
ko-KR | 朝鲜语 |
pt-BR | 葡萄牙语（巴西） |
枚举类型说明
设备类型说明
| 值 | 说明 |
|---|---|
| 1 | 采集器 |
| 2 | 逆变器 |
| 3 | 电表 |
| 4 | EPM |
| 5 | 气象仪 |
设备状态说明
| 值 | 说明 |
|---|---|
| 1 | 正常 |
| 2 | 离线 |
| 3 | 报警 |
| 4 | 故障 |
| 5 | 自定义报警 |
电站类型说明
| 值 | 说明 |
|---|---|
| 1 | 分布式户用 |
| 2 | 分布式商用 |
| 3 | 分布式工业 |
| 4 | 地面电站 |
并网类型说明
| 值 | 说明 |
|---|---|
| DISTRIBUTED_FULLY | 分布式全额上网 |
| EXCESS | 余量上网 |
| BATTERY_BACKUP | 储能+上网 |
区域-字典信息
报警代码含义
响应状态值说明
| 值 | 说明 |
|---|---|
| 200 | 处理成功 |
| 400 | 参数非法 |
| 401 | 账号未认证 |
| 403 | 账号没有权限 |
| 603 | 数据不存在 |
| 604 | 相同名称数据已存在 |
| 609 | 更新数据失败 |
| 501 | 账号已过期 |
| 502 | 账号已被锁定 |
| 503 | 账号凭证已过期 |
| 504 | 账号已被禁用 |
| 505 | 账号不存在 |
| 506 | 账号或密码不正确 |
| 507 | 账号已存在 |
| 508 | 未经认证的token |
| 510 | 验证码错误 |
| 513 | 账号已注销 |