mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 13:37:22 +00:00
e02c24bd3a
Created by Github action --------- Co-authored-by: Abdul Rahman <ar5438376@gmail.com> Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com> Co-authored-by: Charles Bochet <charles@twenty.com>
57 lines
No EOL
5.5 KiB
Text
57 lines
No EOL
5.5 KiB
Text
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: Discover how to use our APIs.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## 概要
|
||
|
||
Twenty APIは、開発者がTwenty CRMプラットフォームをプログラムで操作することを可能にします。 APIを使用すると、Twentyを他のシステムと統合し、データ同期を自動化し、顧客データを中心にカスタムソリューションを構築できます。 APIは、**作成、読み取り、更新、削除** などのコアCRMオブジェクト（人物や企業など）を操作するエンドポイントを提供し、メタデータの設定にもアクセスできます。 APIを使用すると、Twentyを他のシステムと統合し、データ同期を自動化し、顧客データを中心にカスタムソリューションを構築できます。 APIは、**作成、読み取り、更新、削除** などのコアCRMオブジェクト（人物や企業など）を操作するエンドポイントを提供し、メタデータの設定にもアクセスできます。
|
||
|
||
**APIプレイグラウンド：** アプリの設定内でAPIプレイグラウンドにアクセスできます。 **APIプレイグラウンド：** アプリの設定内でAPIプレイグラウンドにアクセスできます。 To try out API calls in real-time, log in to your Twenty workspace and navigate to **Settings → APIs & Webhooks**. これにより、アプリ内APIプレイグラウンドとAPIキーの設定が開きます。
|
||
**[API設定に進む](https://app.twenty.com/settings)**
|
||
**[API設定に進む](https://app.twenty.com/settings)**
|
||
|
||
## 認証
|
||
|
||
TwentyのAPIは認証にAPIキーを使用します。 TwentyのAPIは認証にAPIキーを使用します。 保護されたエンドポイントへの全てのリクエストには、ヘッダーにAPIキーを含める必要があります。
|
||
|
||
- **APIキー:** Twentyアプリの**API設定**ページで新しいAPIキーを生成できます。 各APIキーはCRMデータへのアクセスを許可する秘密トークンなので、安全に保管してください。 キーが漏洩した場合は、設定から解除し、新しいものを生成してください。 各APIキーはCRMデータへのアクセスを許可する秘密トークンなので、安全に保管してください。 キーが漏洩した場合は、設定から解除し、新しいものを生成してください。
|
||
- **認証ヘッダー:** APIキーを取得したら、HTTPリクエストの`Authorization`ヘッダーにそれを含めてください。 Bearerトークン方式を使用してください。 例: Bearerトークン方式を使用してください。 例:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
`YOUR_API_KEY`を取得したキーに置き換えてください。 このヘッダーは**全てのAPIリクエスト**に必要です。 トークンが欠落しているか無効な場合、APIは認証エラー（HTTP 401 未認可）で応答します。
|
||
|
||
## APIエンドポイント
|
||
|
||
全てのリソースにRESTまたはGraphQLを介してアクセスできます。
|
||
|
||
- **クラウド:** `https://api.twenty.com/`またはカスタムドメイン/サブドメイン
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
エンドポイントは**コアAPI**と**メタデータAPI**の2つに分類されます。 **コアAPI**は主要なCRMデータ（例：人物、企業、ノート、タスク）を扱い、**メタデータAPI**は設定データ（カスタムフィールドやオブジェクト定義など）をカバーします。 ほとんどの統合は主にコアAPIを使用します。 **コアAPI**は主要なCRMデータ（例：人物、企業、ノート、タスク）を扱い、**メタデータAPI**は設定データ（カスタムフィールドやオブジェクト定義など）をカバーします。 ほとんどの統合は主にコアAPIを使用します。
|
||
|
||
### コアAPI
|
||
|
||
Accessed on `/rest/` or `/graphql/`.
|
||
**コアAPI**はコアCRMエンティティ（人物、企業、ノート、タスク）とその関係を管理するための統一されたインターフェイスを提供し、**RESTとGraphQL**のインタラクションモデルを提供します。
|
||
|
||
### メタデータAPI
|
||
|
||
`/rest/metadata/`または`/metadata/`上でアクセスされます。
|
||
メタデータAPIエンドポイントはスキーマと設定に関する情報を取得することができます。 例えば、カスタムフィールド、オブジェクトスキーマなどの定義を取得できます。
|
||
|
||
- **エンドポイントの例：**
|
||
|
||
- `GET /rest/metadata/objects` – 全オブジェクトタイプとそのメタデータ（フィールド、関係）をリスト表示。
|
||
- `GET /rest/metadata/objects/{objectName}` – 特定のオブジェクト（例：人物、企業）のメタデータを取得。
|
||
- `GET /rest/metadata/picklists` – CRMで定義されたピックリスト（ドロップダウン）フィールドオプションを取得。
|
||
|
||
一般的に、メタデータエンドポイントはデータの構造（ダイナミック統合やフォームビルディング用）の理解に使用され、実際のレコードを管理するためではありません。 ほとんどの場合、読み取り専用です。 これらも認証が必要です（APIキーを使用）。 |