API 參考文件

內部 API 參考文件

這些端點支援 IVGraph 網頁應用程式的運作。除非另有註明,否則皆須使用 JWT 身分驗證。此處列出供參考;若要進行整合,請優先使用 V1 LLM API。

使用者與個人資料

方法 端點 說明
GET /api/auth/me/ 目前使用者資訊(id、email、username、is_staff)
GET /api/auth/validate/ 檢查 JWT 權杖是否有效
POST /api/auth/refresh/ 更新存取權杖
POST /api/auth/logout/ 將更新權杖列入黑名單
GET /api/user/me/ 使用者個人資料詳情
PUT /api/user/me/ 更新使用者個人資料
GET /api/user/profile/ 使用者個人資料檢視

推薦系統

方法 端點 說明
GET /api/referral/my-code/ 取得使用者的推薦碼
POST /api/referral/apply/ 套用推薦碼
GET /api/referral/stats/ 推薦統計資料

Notion OAuth

方法 端點 說明
GET /api/integrations/auth/notion/ 啟動 Notion OAuth 流程(重新導向至 Notion)
GET /api/integrations/auth/notion/callback OAuth 回呼(以授權碼交換權杖)
GET /api/integrations/auth/notion/status 檢查 OAuth 連線狀態
POST /api/integrations/auth/logout/ 中斷 Notion 整合連線
POST /api/integrations/auth/delete-account/ 刪除使用者帳號及所有資料

工作空間管理

方法 端點 說明
GET /api/integrations/workspaces/ 列出使用者的 Notion 工作空間
GET /api/integrations/workspaces/<id>/ 工作空間詳情
POST /api/integrations/workspaces/<id>/primary/ 設為主要工作空間

同步管理

方法 端點 說明
GET /api/integrations/status/ 整合與同步狀態
GET /api/integrations/notion/permissions/ 檢查 Notion API 權限
POST /api/integrations/airbyte/setup/ 為工作空間設定 Airbyte 連線
GET /api/integrations/airbyte/setup/progress/ 設定進度
POST /api/integrations/airbyte/sync/ 觸發增量同步
POST /api/integrations/airbyte/sync/cancel/ 取消正在執行的同步
GET /api/integrations/airbyte/sync/progress/ 同步進度(請輪詢此端點)
POST /api/integrations/airbyte/full-refresh/ 完整資料更新(重新同步所有資料)

帳務(Stripe)

方法 端點 說明
GET /api/billing/plans/ 列出可用的訂閱方案
POST /api/billing/create-checkout/ 建立 Stripe 結帳工作階段
POST /api/billing/confirm-checkout/ 確認已完成的結帳
GET /api/billing/subscription/ 取得使用者的訂閱詳情
POST /api/billing/portal/ 建立 Stripe 客戶入口網站連結

樣式規則與圖譜設定

方法 端點 說明
GET /api/databases/ 列出可作為規則套用目標的資料庫
GET/PUT /api/graph-settings/ 全域圖譜設定(顏色、開關)
GET/POST /api/advanced-rules/ 列出/建立進階樣式規則
GET/PUT/DELETE /api/advanced-rules/<id>/ 管理個別規則
POST /api/advanced-rules/reorder/ 依優先順序重新排列規則
GET/POST /api/style-presets/ 列出/建立樣式預設組
GET/PUT/DELETE /api/style-presets/<id>/ 管理個別預設組
POST /api/style-presets/<id>/activate/ 啟用預設組
POST /api/style-presets/<id>/duplicate/ 複製預設組

服務權杖管理

方法 端點 說明
GET /api/tokens/ 列出使用者的服務權杖
POST /api/tokens/ 建立新的服務權杖
DELETE /api/tokens/<id>/ 撤銷權杖(永久)

建立權杖的詳細說明,請參閱身分驗證。

其他

方法 端點 身分驗證 說明
GET /api/connections/ JWT 列出使用者的 Airbyte 連線
GET /api/integrations/ JWT 整合總覽
GET /api/activity/ JWT 近期活動紀錄
GET /api/health/ 無 健康狀態檢查
GET /api/health/celery/ 無 Celery 工作程序健康狀態
GET /api/stats/public/ 無 平台統計資料(24h 快取)
POST /api/errors/report/ 無 前端錯誤回報