跳转到主要内容
Header
Twenty 被設計為對開發者友好,提供強大的 API,可以適應您的自定義數據模型。 我們提供四種不同的 API 類型,以滿足不同的集成需求。 我們提供四種不同的 API 類型,以滿足不同的集成需求。

開發者優先策略

Twenty 特別為您的數據模型生成 API,這意味著:
  • 不需要長 ID:直接在端點中使用您的對象和字段名稱
  • 標準和自定義對象平等對待:您的自定義對象將獲得與內置對象相同的 API 對待
  • 專用端點:每個對象和字段都有自己的 API 端點
  • 自定義文件:專為您的工作區數據模型生成
您的自定義 API 會生成個性化文件,通過設置→ API 和 Webhooks 獲取 API 鍵後即可訪問。 此文件反映了您的具體數據模型和字段配置。 此文件反映了您的具體數據模型和字段配置。

四種 API 類型

Twenty 提供了 RESTGraphQL 格式的 API:

REST API

1. REST 資料 API

  • 目的:管理您的工作區和數據模型結構
  • 用例
    • 創建、修改或刪除對象和字段
    • 配置工作區設置
    • 管理數據模型關係
  • 訪問:可通過 REST 端點獲取

2. REST 核心 API

  • 目的:管理您的實際數據記錄
  • 用例
    • 創建、讀取、更新、刪除記錄
    • 查詢特定數據
    • 管理記錄關係
  • 訪問:可通過 REST 端點獲取

GraphQL API

3. GraphQL 資料 API

  • 目的:與 REST 資料 API 一樣,但具有 GraphQL 的優勢
  • 用例:相同的工作區和數據模型管理
  • 附加優勢
    • 在一個請求中查詢多種類型的元數據
    • 精確的字段選擇
    • 複雜查詢的更佳性能

4. GraphQL 核心 API

  • 目的:與 REST 核心 API 相同,但具有 GraphQL 的優勢
  • 用例:相同的數據記錄管理
  • 附加優勢
    • 批量操作:適用於所有操作
    • 上插操作:一次調用中創建或更新記錄
    • 在一個請求中查詢關係
    • 精確的數據提取

批量操作

REST 和 GraphQL 批量支持

REST 和 GraphQL API 都支持多數操作的批量操作:
  • 批量大小:每個請求最多可包含 60 條記錄
  • 可用操作:創建、更新、刪除多條記錄
  • 性能:明顯快於單獨的 API 調用

僅有 GraphQL 功能

  • 批量上插:僅限於 GraphQL API
  • 使用:使用複數對象名稱 (例如,CreateCompanies 而非 CreateCompany)
  • 要求:這就是為什麼單數和複數對象名稱必須不同的原因

API 文件訪問

  1. 前往 設置 → API 和 Webhooks
  2. 創建 API 密鑰(必須有文件訪問權限)
  3. 訪問您的自定義文件和沙盒
  4. 用您的實際數據模型測試 API
您的文件對您來說是獨一無二的,因為它反映了您的自定義對象、字段和關係。

何時使用每個 API

當需要以下選擇條件使用元數據 API:

  • 設置您的數據模型
  • 創建自定義對象或字段
  • 配置工作區設置

使用核心 API 當需要:

  • 管理日常數據(人員、公司、機會)
  • 與外部系統集成
  • 構建自定義應用程序
  • 自動化數據工作流

選擇 GraphQL 當:

  • 您需要批量操作
  • 您想減少 API 調用
  • 您需要上插功能
  • 您在構建複雜的集成

選擇 REST 當:

  • 您更喜歡簡單的 API 結構
  • 您在構建基本的集成
  • 您的團隊更熟悉 REST
  • 您需要簡單的 CRUD 操作

下一步

  • API 和 Webhooks 設置:學習如何創建 API 密鑰和 Webhooks
  • 自定義文件:通過設置→ API 和 Webhooks 訪問您的個性化 API 文件