本产品（
能耗宝/2022-09-23）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
碳排管理
| API | 标题 | API概述 |
|---|---|---|
| 报送碳排放活动数据 | 报送碳排放活动数据 | |
| GetDataItemList | 获取数据项详情列表 | 本接口用于获取数据项详情列表。 |
| PushItemData | 推送数据项数据 | 推送数据项数据。 |
| RecalculateCarbonEmission | 碳盘查重新计算 | 重新计算碳排放。 |
| 查询产品碳足迹结果 | 查询产品碳足迹结果 | |
| GetFootprintList | 获取产品碳足迹列表 | 获取产品碳足迹列表。 |
| GenerateResult | 生成碳足迹结果 | 生成指定碳足迹的报告。 |
| IsCompleted | 生成报告完成状态查询 | 生成报告完成状态查询。 |
| GetPcrInfo | 获取产品碳足迹PCR报告oss地址 | 获取产品碳足迹PCR报告oss地址。 |
| GetGwpInventorySummary | 获取碳足迹总量 | 本接口用于获得产品碳足迹总量，以及碳足迹贡献占比的Top4类型详情。 |
| GetGwpBenchmarkSummary | 获取主动减碳量总量 | 获取主动减碳量总量。 |
| GetEpdSummary | 获取各种环境影响排放总量 | 获取各种环境影响排放总量。 |
| GetInventoryList | 获取排行列表 | 用于获取指定环境影响（methodType）、指定分组汇总级别（group）、指定计算方式下（emissionType）的降序排放列表。 |
| GetGwpBenchmarkList | 获取主动减碳排行列表 | 获取主动减碳排行列表。 |
| GetGwpInventoryConstitute | 获取碳排放构成分析层级图&饼状图 | 用于获取指定产品的碳排放构成分析。碳排放构成分析包括按清单、按类型两种分析维度。在呈现效果上，包括一个层级列表和饼状图。 |
| GetEpdInventoryConstitute | 获取环境影响类别的结果明细 | 获取环境影响类别的结果明细。 |
| GetReductionProposal | 获取减碳建议 | 获取减碳建议。 |
| GetDataQualityAnalysis | 获取数据质量评价结果DQR、DQI | 获取数据质量评价结果DQR、DQI。 |
| 查询组织碳盘查结果 | 查询组织碳盘查结果 | |
| GetEmissionSummary | 获取碳排汇总 | 获取碳排汇总。 |
| GetEmissionSourceConstitute | 获取排放源构成 | 获取排放源构成。 |
| GetCarbonEmissionTrend | 获取碳排趋势 | 获取碳排放趋势。 |
| GetElecConstitute | 电力构成分析 | 本接口用于获取电力构成分析数据。 |
| GetElecTrend | 电力趋势分析 | 本接口用于获取电力趋势分析数据。 |
| GetAreaElecConstitute | 场站电力分析 | 本接口用于获取电力场站分析数据。 |
| GetGasConstitute | 气体构成分析 | 本接口用于获取气体构成分析。 |
| GetOrgConstitute | 碳盘查组织分析 | 本接口用于获取碳盘查组织分析数据。 |
节能减碳
| API | 标题 | API概述 |
|---|---|---|
| 报送能耗数据 | 报送能耗数据 | |
| PushDeviceData | 推送设备测点数据 | 本接口用于推送设备测点数据，例如推送电能表电压等数据。 |
设备管理
| API | 标题 | API概述 |
|---|---|---|
| GetOrgAndFactory | 获取组织和场站 | 查询账号激活的相关组织和场站。需注意的是未在控制台进行激活的场站不会被查询到。 |
| GetDeviceList | 获取设备列表 | 查询账号激活场站的设备列表。 |
| GetDeviceInfo | 获取设备数据 | 查询账号激活场站的设备信息。 |
AI文档处理
| API | 标题 | API概述 |
|---|---|---|
| SubmitDocumentAnalyzeJob | 提交文档解析作业 | 文档解析接口用于文档关键内容抽取，根据用户预设的Key-Value模板从文档中提取出Key-Value信息。 文档解析接口为异步接口，需要先调用文档解析异步提交服务，然后调用文档智能解析结果查询服务GetDocumentAnalyzeResult接口进行结果轮询。 异步提交服务支持本地文件和URL文件两种方式： URL上传的异步提交服务接口为：SubmitDocumentAnalyzeJob接口。 本地文件上传的异步提交服务接口为：SubmitDocumentAnalyzeJobAdvance接口。 |
| GetDocumentAnalyzeResult | 获取文档解析结果 | 文档解析的key-Value结果需要调用文档智能解析结果查询服务GetDocumentAnalyzeResult接口查询。 调用结果查询接口的入参jobId就是前面异步任务提交接口返回的出参jobId，查询结果有处理中、处理成功、处理失败三种情况。 |
| SendDocumentAskQuestion | 在线文档问答 | 在线知识文档问答接口，支持用户使用自然语言对已有的知识文档内容进行提问。问答范围默认是当前账号权限下已解析完成的所有文档，可根据文件夹限制问答范围。 |