REST API Connection 整合 - Amazon Quick
您可以做什麼開始之前準備 API 端點和身分驗證設定 REST API 整合可用的任務動作API 組態選項管理 REST API 整合

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

REST API Connection 整合

透過 Amazon Quick 中的 REST API Connection 整合，您可以使用自訂 REST APIs和 Web 服務執行動作。此整合僅支援動作執行。

您可以做什麼

透過 REST API Connection 整合，您可以透過動作連接器使用自訂 REST APIs和 Web 服務來執行動作。

動作連接器

執行 HTTP 請求、擷取資料，以及使用彈性身分驗證選項與 APIs互動。

注意

REST API Connection 整合不支援資料存取或知識庫建立。它專為任務執行和 API 與自訂 Web 服務的互動而設計。

開始之前

設定 REST API 整合之前，請確定您有下列項目：

  • 具有適當存取許可的 REST API 端點。

  • API 身分驗證登入資料 (OAuth、API 金鑰或其他）。

  • 目標 Web 服務的 API 文件。

準備 API 端點和身分驗證

在 Amazon Quick 中設定整合之前，請準備您的 REST API 端點和身分驗證憑證。REST API Connection 整合支援多種身分驗證方法。選擇符合您 API 需求的方法：

使用者身分驗證 (OAuth)

從您的 API 提供者收集下列資訊：

  • 基本 URL - REST API 基本 URL。

  • 用戶端 ID - OAuth 應用程式用戶端 ID。

  • 用戶端秘密 - OAuth 應用程式用戶端秘密。

  • 權杖 URL - OAuth 權杖端點。

  • 驗證 URL - OAuth 授權端點。

  • 重新導向 URL - OAuth 重新導向 URI。

服務身分驗證 Service-to-service OAuth)

從您的 API 提供者收集下列資訊：

  • 身分驗證類型 - OAuth 2.0 用戶端憑證授予service-to-service身分驗證的流程。

  • 基本 URL - REST API 基本 URL。

  • 用戶端 ID - 用於服務身分驗證的 OAuth 應用程式用戶端識別符。

  • 用戶端秘密 - 用於服務身分驗證的 OAuth 應用程式用戶端秘密。

  • 權杖 URL - 用於取得存取權杖的 OAuth 權杖端點。

自訂標頭和參數

您可以使用自訂標頭和參數進行彈性身分驗證和 API 互動：

  • 自訂身分驗證標頭。

  • API 版本標頭。

  • Content-Type 規格。

  • 自訂查詢參數。

設定 REST API 整合

在您準備好 API 端點和身分驗證憑證之後，請依照下列步驟建立 REST API 整合：

  1. 在 Amazon Quick 主控台中，選擇整合。

  2. 從整合選項中選擇 REST API 連線，然後按一下新增 （加 "+") 按鈕。

  3. 填寫整合詳細資訊：

    • 名稱 - REST API 整合的描述性名稱。

    • 描述 （選用） - 整合的目的。

  4. 選擇您的連線類型：

    • 使用者身分驗證 - 個別使用者存取的 OAuth 型身分驗證。

    • 服務身分驗證 - 服務存取的 API 金鑰型身分驗證。

  5. 根據您選擇的身分驗證方法 （使用者或服務） 填寫連線設定。

  6. 選取下一步。

  7. 檢閱可用的動作。

  8. 選取建立並繼續。

可用的任務動作

建立 REST API 整合之後，您可以檢閱與 REST API 互動的可用動作。常見的 REST API 動作包括：

  • HTTP GET 資料擷取請求。

  • 建立資料的 HTTP POST 請求。

  • 資料更新的 HTTP PUT/PATCH 請求。

  • HTTP DELETE 資料移除請求。

  • 自訂端點互動。

  • JSON 和 XML 資料處理。

  • 查詢參數和標頭管理。

注意

可用的特定動作取決於 REST API 端點和為您的整合設定的身分驗證許可。

API 組態選項

您可以設定 REST API 整合的各個層面，以符合您的特定需求。

端點組態

設定這些端點設定：

  • 基本 URL 和端點路徑。

  • HTTP 方法規格。

  • 請求和回應格式處理。

  • 錯誤處理和重試邏輯。

標籤處理

設定您的整合如何處理不同的資料格式：

  • JSON 請求和回應處理。

  • XML 資料轉換。

  • 表單資料和分段上傳。

  • 二進位資料處理。

管理 REST API 整合

建立 REST API 整合之後，您可以使用下列選項來管理它：

  • 編輯整合 - 更新身分驗證設定、基本 URL 或 API 組態。

  • 共用整合 - 讓整合可供組織中的其他使用者使用。

  • 監控用量 - 檢視整合活動和 API 呼叫指標。

  • 檢閱動作 - 查看可用 REST API 動作的完整清單。

  • 測試端點 - 驗證 API 連線和身分驗證。

  • 刪除整合 - 移除整合並撤銷相關聯的身分驗證。

重要

REST API 整合取決於目標 Web 服務的可用性和組態。API 或身分驗證需求的變更可能會影響整合功能。