文档

API概览

更新时间:
本产品(能耗宝/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概述
空调智控空调智控
BatchSaveInstructionStatus策略执行状态反馈策略执行状态反馈
SetRunningPlan设置运行计划设置运行计划
EditUnfavorableAreaDevices编辑不利区设备编辑不利区设备
EditProhibitedDevices编辑禁用设备编辑禁用设备
BatchUpdateSystemRunningPlan批量更新空调站点运行计划批量设置空调站点运行计划。
报送能耗数据报送能耗数据
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在线文档问答在线知识文档问答接口,支持用户使用自然语言对已有的知识文档内容进行提问。问答范围默认是当前账号权限下已解析完成的所有文档,可根据文件夹限制问答范围。