VisionAI Observ
DataVerse
繁體中文
繁體中文
  • 快速開始Observ旅程
  • 技術規格
    • 適用於 Observ 的技術規格
  • 基本概要
    • 建立您的第一個任務
    • 偵測任務概覽
    • 查看AI偵測事件紀錄
    • 查看任務設定
    • 查看AI即時偵測串流
    • 收到通知
    • 設定AI偵測範圍(ROI)
    • 設定事件區域 Edit Zone
    • 設定AI偵測信賴度
    • 設定AI偵測事件參數
    • 收集您專屬的AI數據資料
    • 管理地點與攝影機
    • 查看歷史事件紀錄
    • 查看歷史事件的統計分析
    • 管理組織及使用者
    • 個人化設定
  • 進階功能
    • 系統設定及資源
    • 輸出資料至DataVerse
    • 管理AI模型庫
    • 客製化專屬場景
    • 添加自定義事件 (Beta)
      • (事件元件) 物件卡
      • (事件元件) 區域卡
      • (事件元件) 邏輯卡
        • (事件元件) 邏輯閘 With
        • (事件元件) 邏輯閘 Overlap
        • (事件元件) 邏輯閘 OR
        • (事件元件) 邏輯閘 NOT
        • (事件元件) 邏輯閘 AND
        • (事件元件) 邏輯閘 Object Tag
        • (事件元件) 邏輯閘 Counting
      • (事件元件) 觸發卡
    • 影片任務 (Beta)
  • AI偵測場景與事件
    • 電子圍籬
    • 火焰及煙霧偵測
    • PPE 個人防護具偵測
    • 通道異物偵測
    • 鏽蝕損壞偵測
    • 行人及車輛流量計數
    • 違規停車
    • 違規使用路線
    • 車輛故障
    • 客流計數
    • 排隊狀況監控
  • API 文件
    • API 設置
    • 事件 Event
    • 任務 Task
    • 攝影機 Camera
    • 地點 Location
    • 組織 Organization
    • 計算目標 Compute Target
  • 支援
    • 疑難排解
      • 解決沒有畫面的問題
      • AI模型沒有正常偵測
      • 為何沒有事件
      • 播放Live畫面的速度或卡頓問題
    • FAQs
      • 攝像機解析度只有1080p可以支持嗎?
      • AI信心閾值和偵測閾值有什麽區別?
      • 平臺上看到即時的推論為什麽一會就停了?
      • ROI、禁區及排除區域等各種區域的區別
      • 突然不想偵測某類事件了,可以停止嗎?
Powered by GitBook
On this page
  • 獲取 API Endpoint
  • 認證 Authentication
  • 1. 獲取 Auth Token
  • 2. 取得 Service ID
  1. API 文件

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

Name
Content
Description
Required

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:

Field
Description
Type
Required

email

您的VisionAI平台電子郵件信箱

string

Yes

password

您的VisionAI平台密碼

string

Yes

Example Request:

POST /users/token
{
  "email": "your_email@example.com",
  "password": "your_password"
}

Response:

{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Il9lYk5wVndQSGhaNks4WjdUVkRONyJ9.eyJpc3MiOiJodHRwczovL2RhdGEtZW5naW5lLXN0YWdpbmcuanAuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDY2MzlkODE0NzI0OGI5NTNjM2FiMmFhYiIsImF1ZCI6WyJodHRwczovL3N0YWdpbmcuZGF0YXZlcnNlLmxpbmtlcnZpc2lvbi5haS9hdXRoMC9hcGkvIiwiaHR0cHM6Ly9kYXRhLWVuZ2luZS1zdGFnaW5nLmpwLmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3MTY0MzczNDMsImV4cCI6MTcxNjUyMzc0Mywic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCBhZGRyZXNzIHBob25lIiwiZ3R5IjoicGFzc3dvcmQiLCJhenAiOiJGV1g0eHFXMXFmNUNrVTlvRkNqZmhaeDJETFV3aGlDMyJ9.iWOaV1kw7iWg0PG_2ZaVIx_-ZGj1Ghl-ckccdibmnbQzUulpbj6ichq2ogHzwRERWXj9OR5pZuDAqJGbNqfw6WYq_9kjxppa7sGedOYIHAb4T9b1tjJrDbhqL9ShMZKk6H0PXHZDnvjQtcsWU-UaXi-W2X8NkhnnvJgtdJHxAF7CLUqm90Aau5jyc8MQDUy8o6grD1ITHoYLg0wyOLyuAu1eyG3Z0b_BKHt5kMXkX_9HOLFuEzkheqwNH-KhWoNO_juNEgTX8CdJSXiSD29Uj6izQ4AetaM99apyKa4nVdpazSwVhnlGMcEh0fatBmFzbqvPd7Fvf-xtMUK32HAc2f"
}

Response Fields:

Field
Description
Type

access_token

The access token to for Bearer authorization

string

2. 取得 Service ID

  1. 請使用您想要訪問的 Workspace 打開 Observ 網站

  2. 前往 「system-management」 系統管理頁面,點擊右上角的 API 配置按鈕。

  3. 您可以在彈出窗口中看到Service ID,請複製該 ID

  4. 在 HTTP header 名稱 X-Service-Id 中填入複製的 ID

Previous排隊狀況監控Next事件 Event

Last updated 10 months ago