跳轉至

GraphQL API

每個 Flowtig 應用程式的主要 API。

GraphQL 是在 Flowtig 平台上建立應用程式的主要介面。

所有業務應用程式——包括聯絡人、工時管理、工時追蹤、發票及倉庫——都透過 GraphQL 進行通訊。此 API 提供對租戶專屬業務資料的強型別存取,同時自動執行權限控制及組織邊界隔離。

應用程式 API

如果您正在開發 Flowtig 應用程式,GraphQL 將會是您的主要 API。

業務邏輯屬於 GraphQL。


為什麼使用 GraphQL?

Flowtig 使用 GraphQL,是因為不同應用程式需要不同的資料,同時又共用相同的平台。

GraphQL 讓每個用戶端都能精確取得所需資料,不需要額外的網路請求,也不需要建立重複的端點。

典型優勢包括:

  • 強型別
  • 精確選擇所需欄位
  • 可預測的 Schema
  • 具備自我描述能力的 API
  • 高效率的資料取得

我可以建立什麼?

每個 Flowtig 應用程式都透過 GraphQL 進行通訊。

例如:

每個應用程式負責自己的業務領域,同時共用相同的驗證及權限模型。


租戶隔離

每個 GraphQL 請求都會在單一組織的環境中執行。

平台會自動強制執行:

  • 租戶隔離
  • 成員資格驗證
  • 服務權限
  • 物件層級授權

應用程式不需要手動切換資料庫,也不需要自行依照組織篩選資料。

內建於平台

多租戶機制是平台架構的一部分,而不是各個應用程式需要自行處理的問題。

更多資訊請參閱架構指南。


Query 與 Mutation

GraphQL 提供兩種主要的操作類型。

Query

當您需要取得資訊時,可以使用 Query。

典型範例包括:

  • 取得聯絡人
  • 取得發票
  • 載入專案
  • 搜尋倉庫物品

Mutation

當需要建立、更新或刪除資料時,可以使用 Mutation。

典型範例包括:

  • 建立發票
  • 更新聯絡人
  • 刪除倉庫物品
  • 完成工作

Schema 設計

每個 Flowtig 應用程式都擁有自己的 GraphQL Schema。

如此可以讓各個業務領域保持清楚分離,同時讓應用程式能夠彼此獨立發展。

平台鼓勵:

  • 清楚的 Schema 所有權
  • 一致的命名方式
  • 強型別
  • 穩定的契約

互動式文件

完整的 GraphQL Schema 可以透過互動式 GraphQL Explorer 查看。

您可以在其中:

  • 瀏覽所有型別
  • 查看可用的 Query
  • 探索 Mutation
  • 檢視資料之間的關聯
  • 執行測試 Query

👉 https://api.flowtig.com/graphql/docs


相關文件

您可能也會對以下內容感興趣:


需要協助嗎?

對 GraphQL API 有任何問題?

您可以查看互動式 API 文件,或透過以下頁面與我們聯絡:

👉 https://flowtig.com/contact