管理API端點 - EventBridge

本文介紹如何建立、查看、編輯、刪除串連配置和API端點，協助您快速整合其他應用。

前提條件

背景資訊

API端點（API Destinations）可以協助您調用第三方SaaS系統或自建系統的HTTP介面，提供低代碼的接入方式，無需更多額外架構即可完成介面調用。藉助API端點，您可以輕鬆構建和對接SaaS應用，打通資料孤島。同時多個API可共用一套串連配置（Connection），提供便捷、可插拔的鑒權能力。

第三方SaaS系統或自建系統等服務中的API包含了API端點和Connection兩部分資訊。

API端點定義了API的中繼資料，您在建立事件規則時可以引用不同的API端點以訪問不同的第三方SaaS系統或自建系統，不同規則也可以引用同一個API端點。多個規則向同一個目標服務API進行事件投遞時，在沒有API端點之前，一旦需要修改某個參數，需要修改所有的規則，但如果將目標服務的API定義成API端點，那麼只需要修改API端點的配置，則所有引用這個API端點的規則，將同步自動更新。

Connection主要用於實現外部服務與當前API端點的連通性。Connection中包含兩部分內容：首先是網路設定，即外部服務與當前API端點之間是通過公網還是私網進行串連。其次，Connection中還包含了鑒權配置資訊。事件匯流排EventBridge選取了目前最常用的三種鑒權方式：Basic Auth、OAuth和API Key。

Basic Auth（基本驗證）：使用時使用者名稱和密碼需要經過驗證才能訪問資料資源。使用者名稱和密碼會被base64編碼並加上Basic空格首碼，一起發送到目標服務。目標服務端進行解碼並認證通過後，會響應事件匯流排EventBridge的請求，如果認證失敗，則直接打回。
OAuth（開放授權）：一種更加安全可靠的授權認證方式。OAuth有四種授權方式，分別是授權碼、隱藏式、密碼式和用戶端憑證。在事件驅動情境中，常用到的是用戶端憑證授權方式。在這種模式下，您需要在事件匯流排EventBridge配置擷取用戶端憑證所需要的一些資訊，包括OAuthService地址、用戶端ID、用戶端密碼等，事件匯流排EventBridge支援GET/POST兩種方式，去擷取用戶端憑證。
API Key：一種比較簡單的認證方式。使用者可以自訂API訪問的KeyName和KeyValue。事件匯流排EventBridge會將其通過HttpHeader的方式，傳輸到服務端進行認證。

串連配置（Connection）

建立Connection

建立API端點時，您可以為該端點指定串連，用於定義API端點的授與類型和參數。

登入事件匯流排EventBridge控制台，在左側導覽列，選擇整合中心 > API端點。
在頂部功能表列，選擇地區，然後單擊串連配置頁簽。

在串連配置頁簽，單擊建立，然後在建立串連配置面板，設定以下參數，完成後單擊確定。

參數	描述	樣本值
串連名稱	設定Connection的名稱。	testName
串連描述	設定Connection的描述。	test
鑒權配置	設定Connection的鑒權方式。取值如下： Basic OAuth用戶端憑據 API Key	Basic
使用者名稱	用於授權的使用者名稱。僅當鑒權配置設定為Basic時需要設定此參數。	Admin
密碼	用於授權的密碼。僅當鑒權配置設定為Basic時需要設定此參數。	******
授權存取點	設定URL存取點，以擷取服務端訪問API時需要的`access_token`。僅當鑒權配置設定為OAuth 用戶端憑據時需要設定此參數。	https://postman-echo.com/oauth1
HTTP Method	擷取`access_token`時的請求類型。僅當鑒權配置設定為OAuth 用戶端憑據時需要設定此參數。	POST
Client ID	您授權的允許擷取`access_token`的ID。僅當鑒權配置設定為OAuth 用戶端憑據時需要設定此參數。	Admin
ClientSecret	您授權的ID的密碼。僅當鑒權配置設定為OAuth 用戶端憑據時需要設定此參數。	******
OAuth Http 調用參數	佈建要求擷取`access_token`時需要添加的要求標頭、請求體和請求參數。僅當鑒權配置設定為OAuth 用戶端憑據時需要設定此參數。	`Parameter:Header key:name Value:eventbridge`
ApiKeyName	用於授權的使用者名稱。僅當鑒權配置設定為API Key時需要設定此參數。	Admin
ApiKeyValue	授權的帳號的密碼。僅當鑒權配置設定為API Key時需要設定此參數。	******
網路選擇	選擇API端點與第三方應用之間的網路連接。預設選擇公網。	公網

其他動作

Connection建立完成後，您可以在控制台上執行查看、編輯、刪除操作。

查看詳情：在已建立的串連配置右側操作列單擊詳情查看基礎資訊、鑒權配置、網路設定及已綁定的API端點。
編輯串連配置：在已建立的串連配置右側操作列單擊編輯修改串連描述。
刪除串連配置：在已建立的串連配置右側操作列單擊刪除，然後閱讀提示對話方塊內的資訊，單擊確定，即可刪除此串連配置。

API端點

建立API端點

登入事件匯流排EventBridge控制台，在左側導覽列，選擇整合中心 > API端點。
在頂部功能表列，選擇地區，然後單擊API端點頁簽。
在API端點頁簽，單擊建立，然後在建立API端點面板，設定以下參數，完成後單擊確定。
1. 在基礎資訊地區，將建立方式設定為自訂建立，然後設定API目標的名稱和描述。
2. 在API配置地區，設定URL為需要訪問的服務端資源的API地址，設定HTTP Method為擷取URL的訪問方式。
3. 在串連配置地區，選擇建立配置或選擇已有，單擊確定。
  - 建立配置：參照上文建立Connection中的內容設定串連配置的名稱、描述、鑒權配置及網路。
  - 選擇已有：在下拉框中選擇提前設定好的串連配置。

選擇API端點為事件目標

登入事件匯流排EventBridge控制台，在左側導覽列，單擊事件匯流排。
在頂部功能表列，選擇地區，在事件匯流排頁面，單擊目標匯流排名稱。
在左側導覽列，單擊事件規則，然後單擊建立規則。
在建立規則面板，完成以下配置，然後單擊建立。
1. 設定規則的基本資料與事件模式。詳細步驟，請參見建立規則。
2. 在配置事件目標頁簽，選擇服務類型為API觸發。
  - 自訂建立API端點：在基礎資訊地區，選擇建立方式為自訂建立，然後參考上文建立API端點中的步驟完成其他配置。
  - 使用已有API端點：在基礎資訊地區，選擇建立方式為使用已有，在下拉框中選擇提前建立好的API端點。

其他動作

API端點建立完成後，您可以在控制台上執行查看、編輯、刪除操作。

查看詳情：在已建立的API端點右側操作列單擊詳情查看基礎資訊、API配置及已串連配置。
編輯API端點：在已建立的API端點右側操作列單擊編輯修改API端點的描述和API配置。
刪除API端點：在已建立的API端點右側操作列單擊刪除，然後閱讀提示對話方塊內的資訊，單擊確定，即可刪除此端點。