REST API
平台管理與系統層級操作。
Flowtig REST API 提供整個 Flowtig 生態系統共用的平台層級功能。
不同於專注於業務應用程式及租戶專屬資料的 GraphQL API,REST API 主要負責驗證、系統管理及基礎架構相關操作。
平台 API
REST 端點專為整個平台的系統層級操作而設計,而不是處理特定應用程式的業務邏輯。
什麼時候應該使用 REST API?
當您需要與 Flowtig 平台本身互動,而不是操作個別應用程式時,應使用 REST API。
典型範例包括:
- 驗證
- 組織管理
- 使用者管理
- 訂閱管理
- 計費
- 平台設定
如果您正在開發發票、聯絡人或倉庫等應用程式內的功能,通常會改用 GraphQL API。
典型職責
REST API 負責管理整個平台共用的資源,包括:
- 組織
- 使用者
- 團隊成員資格
- 角色
- 權限
- 訂閱方案
- 服務訂購
這些資源獨立於任何個別的業務應用程式。
驗證
REST 端點使用以 Token 為基礎的驗證機制進行保護。
每個請求都會在已驗證使用者所屬的組織環境中進行評估。
在授予存取權限之前,平台會執行相應的權限檢查。
如需了解完整的安全性模型,請參閱架構文件。
API 文件
完整的 OpenAPI 規格,包括端點說明、請求範例及回應 Schema,都可以透過互動式 API 文件查看。
👉 https://api.flowtig.com/api/doc/swagger-ui/
透過 Swagger 介面,您可以:
- 瀏覽所有可用的端點
- 檢視請求與回應 Schema
- 執行測試請求
- 查看驗證需求
相關文件
根據您正在開發的內容,以下指南可能也會有所幫助:
需要協助嗎?
如果您對 Flowtig 平台整合有任何問題,請透過官方支援頁面與我們聯絡:
👉 https://flowtig.com/contact