跳至主要內容

REST API 操作的驗證設定

摘要

本文說明如何在 Astra 中設定 REST API 動作的驗證。它涵蓋了支援的驗證方法、何時使用每種方法,以及如何正確設定它們,以確保您的 API 要求被接受。

說明

驗證可告知外部系統來自 Astra 的要求是允許的。設定 REST API 動作時,您可以根據 API 的需求選擇其中一種支援的驗證方法。

Astra 目前支援以下驗證選項:

  • API 金鑰驗證

  • 基本驗證

  • 無驗證

API 金鑰驗證

這是現代 API 最常用的驗證方法。

使用 API 金鑰驗證時,您會在要求標頭中傳送金鑰或權杖。

您需要提供的項目

  • auth_key:HTTP 標頭的名稱(例如,AuthorizationX-API-Key

  • auth_value:標頭中傳送的值(例如,Bearer your-token

常見模式

服務類型

標頭名稱

標頭值格式

大多數 API

Authorization

Bearer your-token

自訂 API

X-API-Key

your-api-key

Webhook 服務

X-Webhook-Secret

your-secret

請確保標頭名稱和值與您的 API 文件預期的完全相符。

基本驗證

基本驗證通常由較舊或傳統系統使用。使用此方法:

  • 您提供使用者名稱和密碼

  • Astra 使用標準 HTTP 基本驗證傳送這些認證資訊

無驗證

某些公開的 Webhook 端點不需要任何驗證。

成功設定的提示

  • 在您的 API 文件中確認所需的驗證方法

  • 仔細檢查標頭名稱、值和權杖格式

  • 儲存後測試 REST API 動作,以確保驗證正常運作

選擇正確的驗證方法,可確保您的 REST API 動作順暢且安全地執行。

是否回答了您的問題?