snapshot of https://github.com/twentyhq/twenty.git (main, 2026-09-17; blobs > 131072B omitted)

packages/twenty-docs/l/ja/developers/extend/capabilities/apis.mdx

@@ -0,0 +1,147 @@
+---
+title: API
+description: REST または GraphQL を使用して、プログラムから CRM データをクエリおよび変更します。
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+Twentyは開発者に優しい設計で、強力なAPIを提供し、カスタムデータモデルに適応します。 異なる統合ニーズに対応する4つの異なるAPIタイプを提供します。 異なる統合ニーズに対応する4つの異なるAPIタイプを提供します。 異なる統合ニーズに対応する4つの異なるAPIタイプを提供します。
+
+## 開発者優先アプローチ
+
+Twenty は、お使いのデータモデルに特化した API を生成します:
+
+* **長いIDが不要**：オブジェクトとフィールド名をエンドポイントに直接使用
+* **標準とカスタムオブジェクトを同等に扱う**：カスタムオブジェクトも組み込みのものと同じAPI処理を受ける
+* **専用エンドポイント**：各オブジェクトとフィールドに固有のAPIエンドポイントが設けられる
+* **カスタムドキュメント**：ワークスペースのデータモデルに特化して生成
+
+<Note>
+API キー作成後、**Settings → API & Webhooks** でパーソナライズされた API ドキュメントを利用できます。 Twenty はカスタムデータモデルに合致する API を生成するため、ドキュメントはお使いのワークスペース専用です。
+</Note>
+
+## 2 つの API タイプ
+
+### コアAPI
+
+`/rest/` または `/graphql/` でアクセスできます。
+
+実際の **レコード**（データ）を扱います:
+
+* People、Companies、Opportunities などを作成・読み取り・更新・削除。
+* データのクエリとフィルター
+* レコードの関係管理
+
+### メタデータAPI
+
+`/rest/metadata/` または `/metadata/` でアクセスできます。
+
+**ワークスペースとデータモデル**を管理:
+
+* オブジェクトやフィールドの作成、変更、削除
+* ワークスペース設定の構成
+* オブジェクト間のリレーションシップを定義
+
+## REST と GraphQL の比較
+
+Core と Metadata の両 API は、REST と GraphQL の形式で利用可能です:
+
+| 形式          | 利用可能な操作                                  |
+| ----------- | ---------------------------------------- |
+| **REST**    | CRUD、バッチ操作、アップサート                        |
+| **GraphQL** | 同様に、**バッチアップサート**、1 回の呼び出しでのリレーションシップクエリ |
+
+ニーズに合わせて選択してください—どちらの形式でも同じデータにアクセスできます。
+
+## APIエンドポイント
+
+| 環境         | ベース URL                   |
+| ---------- | ------------------------- |
+| **クラウド**   | `https://api.twenty.com/` |
+| **セルフホスト** | `https://{your-domain}/`  |
+
+## 認証
+
+すべての API リクエストにはヘッダーに API キーが必要です:
+
+```
+Authorization: Bearer YOUR_API_KEY
+```
+
+### APIキーを作成
+
+1. **Settings → APIs & Webhooks**に移動
+2. **+ Create key** をクリック
+3. 設定:
+   * **Name**: キーのわかりやすい名前
+   * **Expiration Date**: キーの有効期限
+4. **保存**をクリック
+5. **すぐにコピー** — キーは一度しか表示されません
+
+<VimeoEmbed videoId="928786722" title="API キーの作成" />
+
+<Warning>
+API キーは機密データへのアクセスを許可します。 信頼できないサービスと共有しないでください。 漏洩した場合は、直ちに無効化して新しいものを生成してください。
+</Warning>
+
+### API キーにロールを割り当てる
+
+セキュリティを高めるため、アクセスを制限する特定のロールを割り当ててください:
+
+1. **設定 → メンバー → 役割** に移動します
+2. 割り当てるロールをクリック
+3. **割り当て** タブを開く
+4. **API Keys** の下で、**+ Assign to API key** をクリック
+5. API キーを選択
+
+キーはそのロールの権限を継承します。 詳細は[権限](/l/ja/user-guide/permissions-access/capabilities/permissions)を参照してください。
+
+### APIキーの管理
+
+**Regenerate**: Settings → APIs & Webhooks → キーをクリック → **Regenerate**
+
+**Delete**: Settings → APIs & Webhooks → キーをクリック → **Delete**
+
+## API プレイグラウンド
+
+組み込みのプレイグラウンドでブラウザから直接 API をテストできます—**REST** と **GraphQL** の両方で利用可能です。
+
+### プレイグラウンドにアクセス
+
+1. **Settings → APIs & Webhooks**に移動
+2. API キーを作成（必須）
+3. プレイグラウンドを開くには **REST API** または **GraphQL API** をクリック
+
+### 提供内容
+
+* **インタラクティブなドキュメント**: お使いの特定のデータモデル向けに生成
+* **ライブテスト**: ワークスペースに対して実際の API 呼び出しを実行
+* **スキーマエクスプローラー**: 利用可能なオブジェクト、フィールド、リレーションシップを閲覧
+* **リクエストビルダー**: オートコンプリートでクエリを構築
+
+プレイグラウンドはカスタムのオブジェクトとフィールドを反映するため、ドキュメントは常にお使いのワークスペースに対して正確です。
+
+## バッチ操作
+
+REST と GraphQL の両方がバッチ操作をサポートしています:
+
+* **バッチサイズ**：リクエストあたり最大60記録
+* **操作**: 複数のレコードの作成、更新、削除
+
+**GraphQL のみの機能:**
+
+* **バッチアップサート**: 1 回の呼び出しで作成または更新
+* 複数形のオブジェクト名を使用（例：`CreateCompany` ではなく `CreateCompanies`）
+
+## API レートリミット
+
+プラットフォームの安定性を確保するため、API リクエストはレート制限されています:
+
+| 制限         | 値                   |
+| ---------- | ------------------- |
+| **リクエスト**  | 1 分あたり 100 回の呼び出し   |
+| **バッチサイズ** | 1 回の呼び出しあたり 60 レコード |
+
+<Tip>
+バッチ操作を使用してスループットを最大化しましょう—個別のリクエストではなく、1 回の API 呼び出しで最大 60 レコードを処理できます。
+</Tip>

packages/twenty-docs/l/ja/developers/extend/capabilities/webhooks.mdx

@@ -0,0 +1,112 @@
+---
+title: Webhooks
+description: CRM でイベントが発生したときにリアルタイム通知を受信します。
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+ウェブフックは、Twenty でイベントが発生したときに、ポーリング不要でリアルタイムにお使いのシステムへデータをプッシュします。 外部システムとの同期を保ち、オートメーションをトリガーしたり、アラートを送信したりするために使用できます。
+
+## Webhookを作成
+
+1. **Settings → APIs & Webhooks → Webhooks**に移動
+2. **+ Webhookを作成**をクリック
+3. ウェブフックの URL を入力（外部からアクセス可能である必要があります）
+4. **保存**をクリック
+
+ウェブフックは直ちに有効化され、通知の送信を開始します。
+
+<VimeoEmbed videoId="928786708" title="ウェブフックの作成" />
+
+### Webhookを管理
+
+**編集**: ウェブフックをクリック → URL を更新 → **保存**
+
+**削除**: ウェブフックをクリック → **削除** → 確認
+
+## イベント
+
+Twenty は次のイベントタイプに対してウェブフックを送信します。
+
+| イベント        | 例                                                          |
+| ----------- | ---------------------------------------------------------- |
+| **レコードの作成** | `person.created`, `company.created`, `note.created`        |
+| **レコードの更新** | `person.updated`, `company.updated`, `opportunity.updated` |
+| **レコードの削除** | `person.deleted`, `company.deleted`                        |
+
+すべてのイベントタイプはウェブフックの URL に送信されます。 イベントのフィルタリングは将来のリリースで追加される可能性があります。
+
+## ペイロード形式
+
+各ウェブフックは JSON ボディを含む HTTP POST を送信します。
+
+```json
+{
+  "event": "person.created",
+  "data": {
+    "id": "abc12345",
+    "firstName": "Alice",
+    "lastName": "Doe",
+    "email": "alice@example.com",
+    "createdAt": "2025-02-10T15:30:45Z",
+    "createdBy": "user_123"
+  },
+  "timestamp": "2025-02-10T15:30:50Z"
+}
+```
+
+| フィールド     | 説明                          |
+| --------- | --------------------------- |
+| `イベント`    | 何が起きたか（例: `person.created`） |
+| `データ`     | 作成／更新／削除された完全なレコード          |
+| `タイムスタンプ` | イベントが発生した時刻（UTC）            |
+
+<Note>
+受信を確認するために、**2xx HTTP ステータス**（200～299）で応答してください。 2xx 以外の応答は配信失敗として記録されます。
+</Note>
+
+## ウェブフックの検証
+
+Twenty はセキュリティのために各ウェブフックリクエストに署名します。 リクエストが正当であることを確認するために署名を検証してください。
+
+### ヘッダー
+
+| ヘッダー                         | 説明             |
+| ---------------------------- | -------------- |
+| `X-Twenty-Webhook-Signature` | HMAC SHA256 署名 |
+| `X-Twenty-Webhook-Timestamp` | リクエストのタイムスタンプ  |
+
+### 検証手順
+
+1. `X-Twenty-Webhook-Timestamp` からタイムスタンプを取得
+2. 次の文字列を作成: `{timestamp}:{JSON payload}`
+3. ウェブフックシークレットを使用して HMAC SHA256 を計算
+4. `X-Twenty-Webhook-Signature` と比較
+
+### 例（Node.js）
+
+```javascript
+const crypto = require("crypto");
+
+const timestamp = req.headers["x-twenty-webhook-timestamp"];
+const payload = JSON.stringify(req.body);
+const secret = "your-webhook-secret";
+
+const stringToSign = `${timestamp}:${payload}`;
+const expectedSignature = crypto
+  .createHmac("sha256", secret)
+  .update(stringToSign)
+  .digest("hex");
+
+const isValid = expectedSignature === req.headers["x-twenty-webhook-signature"];
+```
+
+## ウェブフック vs ワークフロー
+
+| メソッド                    | 方向  | ユースケース                      |
+| ----------------------- | --- | --------------------------- |
+| **ウェブフック**              | OUT | あらゆるレコード変更を外部システムへ自動通知      |
+| **ワークフロー + HTTP リクエスト** | OUT | カスタムロジック（フィルター、変換）でデータを外部送信 |
+| **ワークフローのウェブフックトリガー**   | IN  | 外部システムから Twenty にデータを受信     |
+
+外部データの受信については、[Webhook トリガーを設定](/l/ja/user-guide/workflows/how-tos/connect-to-other-tools/set-up-a-webhook-trigger)を参照してください。