本產品(
能耗寶/2022-09-23
)的OpenAPI采用ROA簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用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 | 在線文檔問答 | 在線知識文檔問答接口,支持用戶使用自然語言對已有的知識文檔內容進行提問。問答范圍默認是當前賬號權限下已解析完成的所有文檔,可根據文件夾限制問答范圍。 |