orientxorientx

金鑰與身分驗證

建立金鑰、傳送 Authorization,以及處理 401 / 403

金鑰用於識別你的帳戶,並決定可以存取哪些模型。在控制台中建立和撤銷金鑰。 你也可以隨時在控制台中再次查看金鑰的值。

不要將金鑰傳送到瀏覽器

用戶端 JavaScript、行動應用程式二進位檔案或公開儲存庫中的內容,任何人都可能讀取。 應從你自己的後端呼叫 API,再讓前端存取該後端。

以下做法有助於管理金鑰:

  • 每個環境使用獨立金鑰。 分開管理開發、預備和正式環境,避免撤銷一個金鑰時影響其他環境。
  • 從環境變數讀取。 在執行階段讀取 ORIENTX_API_KEY,不要寫死。
  • 洩露後立即輪替。 如果金鑰出現在日誌、截圖或程式碼提交中,請立即撤銷。

身分驗證

每個請求都在 Authorization 請求標頭中攜帶金鑰:

Authorization: Bearer <ORIENTX_API_KEY>

金鑰缺失、格式錯誤或已被撤銷時,回傳 401:

{
  "error": {
    "message": "Invalid API key provided.",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

如果金鑰有效,但無權存取請求中的模型,則回傳 403。 完整狀態碼清單參見速率限制與錯誤。

本頁目錄