本文介紹如何創(chuàng)建、查看、編輯、刪除連接配置和API端點，幫助您快速集成其他應用。

前提條件

開通事件總線EventBridge并授權

背景信息

API端點（API Destinations）可以幫助您調(diào)用第三方SaaS系統(tǒng)或自建系統(tǒng)的HTTP接口，提供低代碼的接入方式，無需更多額外架構即可完成接口調(diào)用。借助API端點，您可以輕松構建和對接SaaS應用，打通數(shù)據(jù)孤島。同時多個API可共用一套連接配置（Connection），提供便捷、可插拔的鑒權能力。

第三方SaaS系統(tǒng)或自建系統(tǒng)等服務中的API包含了API端點和Connection兩部分信息。

API端點定義了API的元數(shù)據(jù)，您在創(chuàng)建事件規(guī)則時可以引用不同的API端點以訪問不同的第三方SaaS系統(tǒng)或自建系統(tǒng)，不同規(guī)則也可以引用同一個API端點。多個規(guī)則向同一個目標服務API進行事件投遞時，在沒有API端點之前，一旦需要修改某個參數(shù)，需要修改所有的規(guī)則，但如果將目標服務的API定義成API端點，那么只需要修改API端點的配置，則所有引用這個API端點的規(guī)則，將同步自動更新。

API端點2
Connection主要用于實現(xiàn)外部服務與當前API端點的連通性。Connection中包含兩部分內(nèi)容：首先是網(wǎng)絡配置，即外部服務與當前API端點之間是通過公網(wǎng)還是私網(wǎng)進行連接。其次，Connection中還包含了鑒權配置信息。事件總線EventBridge選取了目前最常用的三種鑒權方式：Basic Auth、OAuth和API Key。
  • Basic Auth（基本身份驗證）：使用時用戶名和密碼需要經(jīng)過驗證才能訪問數(shù)據(jù)資源。用戶名和密碼會被base64編碼并加上Basic空格前綴，一起發(fā)送到目標服務。目標服務端進行解碼并認證通過后，會響應事件總線EventBridge的請求，如果認證失敗，則直接打回。
  • OAuth（開放授權）：一種更加安全可靠的授權認證方式。OAuth有四種授權方式，分別是授權碼、隱藏式、密碼式和客戶端憑證。在事件驅動場景中，常用到的是客戶端憑證授權方式。在這種模式下，您需要在事件總線EventBridge配置獲取客戶端憑證所需要的一些信息，包括OAuthService地址、客戶端ID、客戶端密碼等，事件總線EventBridge支持GET/POST兩種方式，去獲取客戶端憑證。
  • API Key：一種比較簡單的認證方式。用戶可以自定義API訪問的KeyName和KeyValue。事件總線EventBridge會將其通過HttpHeader的方式，傳輸?shù)椒斩诉M行認證。
API端點

連接配置（Connection）

創(chuàng)建Connection

創(chuàng)建API端點時，您可以為該端點指定連接，用于定義API端點的授權類型和參數(shù)。

  1. 登錄事件總線EventBridge控制臺，在左側導航欄，選擇集成中心 > API端點。
  2. 在頂部菜單欄，選擇地域，然后單擊連接配置頁簽。
  3. 在連接配置頁簽，單擊創(chuàng)建，然后在創(chuàng)建連接配置面板，設置以下參數(shù)，完成后單擊確定。
    參數(shù)描述示例值
    連接名稱設置Connection的名稱。testName
    連接描述設置Connection的描述。test
    鑒權配置設置Connection的鑒權方式。取值如下：
    • Basic
    • OAuth客戶端憑據(jù)
    • API Key
    		Basic
    用戶名用于授權的用戶名。僅當鑒權配置設置為Basic時需要設置此參數(shù)。Admin
    密碼用于授權的密碼。僅當鑒權配置設置為Basic時需要設置此參數(shù)。******
    授權接入點設置URL接入點，以獲取服務端訪問API時需要的access_token。僅當鑒權配置設置為OAuth 客戶端憑據(jù)時需要設置此參數(shù)。https://postman-echo.com/oauth1
    HTTP Method獲取access_token時的請求類型。僅當鑒權配置設置為OAuth 客戶端憑據(jù)時需要設置此參數(shù)。POST
    Client ID您授權的允許獲取access_token的ID。僅當鑒權配置設置為OAuth 客戶端憑據(jù)時需要設置此參數(shù)。Admin
    ClientSecret您授權的ID的密碼。僅當鑒權配置設置為OAuth 客戶端憑據(jù)時需要設置此參數(shù)。******
    OAuth Http 調(diào)用參數(shù)設置請求獲取access_token時需要添加的請求頭、請求體和請求參數(shù)。僅當鑒權配置設置為OAuth 客戶端憑據(jù)時需要設置此參數(shù)。
    Parameter:Header
key:name
Value:eventbridge
    ApiKeyName用于授權的用戶名。僅當鑒權配置設置為API Key時需要設置此參數(shù)。Admin
    ApiKeyValue授權的賬號的密碼。僅當鑒權配置設置為API Key時需要設置此參數(shù)。******
    網(wǎng)絡選擇選擇API端點與第三方應用之間的網(wǎng)絡連接。默認選擇公網(wǎng)。公網(wǎng)

其他操作

Connection創(chuàng)建完成后，您可以在控制臺上執(zhí)行查看、編輯、刪除操作。

其他操作
  • 查看詳情：在已創(chuàng)建的連接配置右側操作列單擊詳情查看基礎信息、鑒權配置、網(wǎng)絡配置及已綁定的API端點。
  • 編輯連接配置：在已創(chuàng)建的連接配置右側操作列單擊編輯修改連接描述。
  • 刪除連接配置：在已創(chuàng)建的連接配置右側操作列單擊刪除，然后閱讀提示對話框內(nèi)的信息，單擊確定，即可刪除此連接配置。

API端點

創(chuàng)建API端點

  1. 登錄事件總線EventBridge控制臺，在左側導航欄，選擇集成中心 > API端點。
  2. 在頂部菜單欄，選擇地域，然后單擊API端點頁簽。
  3. 在API端點頁簽，單擊創(chuàng)建，然后在創(chuàng)建API端點面板，設置以下參數(shù)，完成后單擊確定。
    1. 在基礎信息區(qū)域，將創(chuàng)建方式設置為自定義創(chuàng)建，然后設置API目標的名稱和描述。
    2. 在API配置區(qū)域，設置URL為需要訪問的服務端資源的API地址，設置HTTP Method為獲取URL的訪問方式。
    3. 在連接配置區(qū)域，選擇新建配置或選擇已有，單擊確定。
      • 新建配置：參照上文創(chuàng)建Connection中的內(nèi)容設置連接配置的名稱、描述、鑒權配置及網(wǎng)絡。
      • 選擇已有：在下拉框中選擇提前設置好的連接配置。

選擇API端點為事件目標

  1. 登錄事件總線EventBridge控制臺，在左側導航欄，單擊事件總線。
  2. 在頂部菜單欄，選擇地域，在事件總線頁面，單擊目標總線名稱。
  3. 在左側導航欄，單擊事件規(guī)則，然后單擊創(chuàng)建規(guī)則。
  4. 在創(chuàng)建規(guī)則面板，完成以下配置，然后單擊創(chuàng)建。
    1. 設置規(guī)則的基本信息與事件模式。詳細步驟，請參見創(chuàng)建規(guī)則。
    2. 在配置事件目標頁簽，選擇服務類型為API觸發(fā)。
      • 自定義創(chuàng)建API端點：在基礎信息區(qū)域，選擇創(chuàng)建方式為自定義創(chuàng)建，然后參考上文創(chuàng)建API端點中的步驟完成其他配置。
      • 使用已有API端點：在基礎信息區(qū)域，選擇創(chuàng)建方式為使用已有，在下拉框中選擇提前創(chuàng)建好的API端點。

其他操作

API端點創(chuàng)建完成后，您可以在控制臺上執(zhí)行查看、編輯、刪除操作。

其他操作
  • 查看詳情：在已創(chuàng)建的API端點右側操作列單擊詳情查看基礎信息、API配置及已連接配置。
  • 編輯API端點：在已創(chuàng)建的API端點右側操作列單擊編輯修改API端點的描述和API配置。
  • 刪除API端點：在已創(chuàng)建的API端點右側操作列單擊刪除，然后閱讀提示對話框內(nèi)的信息，單擊確定，即可刪除此端點。