Skip to main content
Living Security API v1 Postman 集合是由驅動 API v1 參考文件的同一份 OpenAPI 規格產生,因此始終與已發布的合約一致。它涵蓋所有 /v1 操作, 依資源分組,並已預先設定驗證。

下載

下載連結會提示您先使用 Living Security 帳戶登入, 才會提供檔案。

Living Security API v1 集合

包含所有 /v1 操作的 Postman Collection v2.1,並已預先設定 Basic 驗證。 集合的 baseUrl 為空白——在發送請求之前,請先選擇區域環境。下載集合

正式環境(US)

baseUrl 已預設為 https://api.us-east-1.livingsecurity.ai/v1, 並包含需要您填寫的空白 apiKeySecret 與 contractVersion 變數。下載 US 正式環境

正式環境(EU)

baseUrl 已預設為 https://api.eu-west-1.livingsecurity.ai/v1, 並包含需要您填寫的空白 apiKeySecret 與 contractVersion 變數。下載 EU 正式環境

環境範本

相同的變數,但 baseUrl 為空白,適用於非正式環境的設定。下載環境範本

在 Postman 中設定

1

導入檔案

在 Postman 中,選擇 Import,並放入集合檔案,以及與貴組織相符的 正式環境(US)或正式環境(EU)檔案。請參閱區域。
2

建立 API 金鑰

在儀表板中,開啟 設定 → 整合與開發人員 → Developer Hub,建立服務帳戶,然後建立 API 金鑰。金鑰密碼以 lsk_live_ 開頭, 且僅顯示一次——請立即複製。詳情請參閱 API 金鑰。
3

貼上金鑰密碼

設定 apiKeySecret 變數——可在已導入的環境中設定 (建議使用,因為它是機密類型的變數),或在集合的 變數 索引標籤中設定。
4

發送請求

選擇已導入的區域環境,開啟任一請求——例如 Organization → Retrieve the organization——然後按一下 Send。在選擇環境之前,請勿 發送請求;集合的 baseUrl 刻意保持空白。

驗證的預先設定方式

集合在集合層級設定 Basic 驗證,使用者名稱為 apikey, 密碼為 {{apiKeySecret}}。API 接受在任一 Basic 驗證欄位中提供金鑰密碼, 因此在設定變數後即可直接使用。 如果您偏好使用 Bearer 驗證,請將集合的 Authorization 類型變更為 Bearer Token,並使用 {{apiKeySecret}} 作為權杖——API 兩種方式都接受相同的金鑰密碼。 使用 API 金鑰搭配 Bearer 標頭不需要 OAuth。若要使用 OAuth, 請將 Bearer Token 設為您的 OAuth 存取權杖,而非 API 金鑰密碼。 如需選擇方法,請參閱驗證; 權杖與用戶端設定,請參閱 OAuth 用戶端憑證。

合約版本標頭

每個請求都帶有 Living-Security-Version 標頭,預設為 {{contractVersion}},且預設為停用。保持停用即可使用貴組織 固定的合約版本。啟用後可將請求固定到 特定的已發布版本——已發布的版本請參閱變更記錄。

查詢參數與本文

清單端點的篩選條件(limit、page_token 以及各資源專屬的篩選條件) 已包含在每個請求中但處於停用狀態,因此全新導入後即可成功呼叫每個 端點。請啟用並填寫您需要的項目——有關 page_token 的運作方式,請參閱 分頁。POST 操作的請求 本文已預先填入具類型的預留位置值。
每次合約變更時,集合都會根據已發布的 OpenAPI 規格重新產生—— 請下載最新副本,而不要編輯您想保持最新的請求。