API 設置
歡迎來到 Observ 平台的 API 配置指南。
本篇文件提供有關如何在 Observ 環境中設置和管理 API 的詳細說明,理解如何配置和使用 API 整合和自動化流程能幫助您更有效地使用 Observ 平台。
獲取 API Endpoint
Endpoint URL:在 Observ 網網址後端添加
/apiserver
來訪問 API 服務。範例:如果您的 Observ URL 是
https://www.linkervisionai.com/observ
,那麼您的 API 端點將是https://www.linkervisionai.com/observ/apiserver
認證 Authentication
為了確保對我們的 API 的安全訪問,每次調用都需要進行認證。
以下是設置 HTTP API 調用所需標頭以及 Websocket 連接參數的詳細信息。
Headers
Authorization
Bearer {bearer token}
Do authentication
Yes
X-Service-Id
Get from Observ UI
Which workspace you want to access
Yes
1. 獲取 Auth Token
此 API endpoint 用於獲取認證所需的 access token。請注意以下重要事項:
Token 時效: 獲得的 token 在 24 小時後過期。
使用頻率限制: 此 API 的使用是有限制的;頻繁調用會導致超過使用限制。
Endpoint: POST /users/token
Body:
您的VisionAI平台電子郵件信箱
string
Yes
password
您的VisionAI平台密碼
string
Yes
Example Request:
Response:
Response Fields:
access_token
The access token to for Bearer authorization
string
2. 取得 Service ID
請使用您想要訪問的 Workspace 打開 Observ 網站
前往 「system-management」 系統管理頁面,點擊右上角的 API 配置按鈕。
您可以在彈出窗口中看到
Service ID
,請複製該 ID在 HTTP header 名稱
X-Service-Id
中填入複製的 ID
Last updated