エンドポイント詳細
概要
エンドポイント詳細は、1つのエンドポイントに関するすべての設定を管理するページです。この画面から以下のことが行えます:
- エンドポイント情報の確認と編集（名前、説明、URL、バージョン）
- 有効 / 無効の切り替え
- 本番へのデプロイと再デプロイ
- デフォルトAPIキーの管理
- 必須フィールドの追加と削除
- Webhookとシステム通知の設定
- エンドポイントの削除
コラボレーションキーの管理（キーの発行、招待、権限）は別のページで行います。詳しくはコラボレーションキーをご覧ください。
協力者として参加している場合は、アクセス可能なセクションのみが表示されます（オーナー専用セクションは自動的に非表示になります）。
このページへのアクセス方法
- トップメニューAPI → 一覧からエンドポイント名をクリック
- ダッシュボード最近のアクティビティ → エンドポイントをクリック
- オンボーディングステップ1完了後に自動遷移
Freeプラン警告バナー
Freeプラン利用時に上部に表示されます。Freeプランでは、エンドポイントを自由に作成して試すことができます。作成から7日後に自動クリーンアップされますが、いつでも新しいものを作成できますので、どんどん試してみてください。
有効/無効とデプロイボタン
オーナー専用エリアです。
- 有効/無効ボタン（電源アイコン）: すべての環境でAPIコールを一時的に停止したい場合に使用します。無効中はコールが拒否されますが、データは保持されます。
本番にデプロイボタン（サンドボックスタブのみ）:- 現在のサンドボックス設定を本番にコピーします
- 条件: サンドボックスで少なくとも1回のテストコールを完了している必要があります
協力者がページにアクセスする場合は、代わりにデプロイリクエストボタンが表示されます。オーナーにデプロイリクエストメッセージを送信します。
環境タブ
ヘッダーバーの下に、サンドボックス | 本番タブがあります。2つの環境は完全に独立しています。
推奨ワークフローは: サンドボックスでテストし協力者と確認 → 本番にデプロイ → 運用開始。変更が必要な場合は、まずサンドボックスで修正してから再デプロイしてください。
サンドボックス
- サンドボックスAPIキー（
tm_test_）でのコール用の環境です - テスト専用です。本番稼働前に自由に試してください
- サンドボックスデータは30日後に自動削除されます（全プラン共通）
本番
- 本番APIキー（
tm_live_）でのコール用の環境です - 本番運用用です。アカウントが有効な間、データは永続的に保持されます。30日を超えたレコードは自動的にアーカイブされます（有料プラン）
- 本番デプロイ前は、本番キーでのコールは拒否され、ログにも記録されません
概要カード
エンドポイントの基本情報を含むセクションです。
| 項目 | 説明 |
|---|---|
| 説明 | エンドポイントの説明。オーナーはサンドボックスタブでインライン編集可能 |
| エンドポイントURL | 実際のAPIコールアドレス。このURLにPOST/GET/PUT/DELETEリクエストを送信します。 コピーボタンあり |
| バージョン | 設定バージョン。デプロイごとに増加します |
| 作成日 | エンドポイントの作成時間 |
| 更新日 | 最後の設定変更時間（サンドボックス） |
| 公開日 | 本番デプロイ時間（本番タブのみ） |
デフォルトAPIキー
オーナー専用エリアです。
- エンドポイント作成時に発行されたデフォルトAPIキーです
- 右側のテスト開始ボタンからアクセスできるテスト＆連携ガイドページでの認証に使用します
- 表示 / 非表示トグルで画面上のキーの表示・非表示を切り替えます
- 再生成ボタン: 以前のキーは即座に無効になります。漏洩が疑われる場合のみ使用してください
協力者がページにアクセスすると、このセクションは割り当てられたコラボレーションキーカードに置き換わります。
コラボレーションキー
ここではサマリーカードのみが提供されます。キーの作成、招待、権限管理は別の管理ページで行います。
- オーナー表示:
すべて表示ボタンと協力者ごとのサマリー（名前、招待数） - 協力者表示: 自分に割り当てられたキーの権限バッジ
詳しい手順はコラボレーションキーをご覧ください。
必須フィールド
APIコールに必ず含めなければならないJSONフィールドを定義します。詳しい説明は新規エンドポイント作成をご覧ください。
- フィールドの追加や編集は
編集ボタンをクリックしてください - 編集中は、フィールドの追加、削除、型の変更が可能です。
保存またはキャンセルで完了します - 保存するとサンドボックスの設定が更新されます。本番に反映するには再デプロイが必要です
- デプロイ後でも、必須フィールドの変更は既存の保存済みデータに影響しません。更新されたフィールドルールは新しい受信コールにのみ適用されます
Webhook
オーナー専用エリアです。
APIコールが正常に処理されると、指定したWebhook URLにセカンダリリクエストを送信できます。Webhookの成否に関わらず、データの保存は常に完了します。
入力項目
- Webhook URL: Webhookを受信するアドレス（HTTPS推奨）
- 認証ヘッダー（任意）: 認証ヘッダーキー。デフォルトは
Authorization - 認証値（任意）: 認証ヘッダーの値。例:
Bearer abc123
認証が不要なWebhook（シンプルなレシーバー、URLに埋め込まれたトークンなど）の場合は、認証フィールドを空のままにしてください。
Webhookポリシーの概要
- リトライ: 失敗時は最大3回リトライ、1秒 → 2秒バックオフ
- タイムアウト: 7秒以内にレスポンスが必要。超過すると失敗として扱われます
Webhookペイロード
APIコールが処理されると、以下のJSONペイロードがWebhook URLに送信されます。実際のフォーマットは、スクリーンショットのWebhookペイロード例セクションを展開して確認できます。
| フィールド | 説明 |
|---|---|
| id | 保存されたレコードの一意のID |
| operation | 実行されたアクション（create、update、delete） |
| status | 処理結果（success、failed） |
| endpoint_slug | エンドポイント識別子 |
| payload | コーラーが送信した元のJSONデータがそのまま含まれます（削除時はnull） |
| target_record_id | 対象レコードID（更新/削除時に含まれます） |
| processed_at | 処理完了時間 |
協力者Webhook
協力者がWebhookを必要とする場合は、APIリクエストにX-Webhook-Callbackなどのヘッダーを含めることで独自に設定できます。協力者WebhookはオーナーのWebhookとは独立して動作し、ペイロードフォーマットは同一です。詳しい設定方法はテスト＆連携ガイドをご覧ください。
通知
Webhookとは別に、システムイベントのみをDiscord、Slack、またはTelegramに送信する機能です。リクエストペイロードは含まれず、どのイベントが発生したかのみが通知されます。
構造
- 環境タブの分離なし: 通知設定は環境ごとではなく、エンドポイントごとに管理されます
- オーナー表示: 単一の通知設定カード
- 協力者表示: 割り当てられたコラボレーションキーごとの通知カード
入力項目
- チャンネル: Discord / Slack / Telegram
- Webhook URL: 各プラットフォームで事前に設定したBot/WebhookのURL
- Chat ID: Telegramの場合のみ必要
Webhook/Botの設定手順は各プラットフォームの公式ドキュメントをご参照ください。
通知イベント
| イベント | 受信者 | 説明 |
|---|---|---|
| Webhook配信失敗（自身のWebhookのみ） | 該当者 | オーナーのWebhook失敗 → オーナー / 協力者のWebhook失敗 → 協力者 |
| 月間使用量80%警告（オーナーのみ） | オーナー | 月間使用量が80%に到達 |
| 月間使用量制限超過（オーナーのみ） | オーナー | 月間使用量が100%を超過 |
| 新しいデプロイリクエスト（オーナーのみ） | オーナー | 協力者が本番デプロイをリクエスト |
| デプロイ完了（協力者のみ） | 協力者 | オーナーがデプロイを完了 |
備考
- 通知配信の失敗はリトライされず、配信履歴も保存されません
- すべての通知メッセージは英語です
デンジャーゾーン
オーナー専用エリアです。
- **
エンドポイントを削除**ボタン - 削除すると即座かつ完全に以下が削除されます:
- エンドポイントの設定自体
- サンドボックスと本番のすべてのAPIレコード
- 関連する統計 / デプロイリクエスト / Webhook / 通知設定 / コラボレーションキー / アーカイブメタデータ
- 協力者もアクセスを失います
- 元に戻せません — 確認ダイアログでエンドポイント名を入力する必要があります
右サイドバー
詳細ページの右側には、環境に応じて異なるクイックカードが表示されます。
APIコールレコード
このエンドポイントへのAPIコールの結果を確認できるページに移動します。リクエストの成功/失敗、ペイロード、Webhookステータスなどを詳細に確認できます。
サンドボックステスト
サンドボックスタブで表示されます。
ブラウザで直接APIコールをテストし、連携方法を確認できるページに移動します。詳しくはテスト＆連携ガイドをご覧ください。
本番コンソール
本番タブで、デプロイ完了後、オーナーのみに表示されます。
ダッシュボードから本番データを直接管理するためのコンソールです。協力者がGETで取得する商品一覧やお知らせなどの事前投入に便利です。POST（作成）、GET（読取）、PUT（更新）、DELETE（削除）をサポートします。コンソールはオーナーのAPIキーで実行され、協力者Webhookはトリガーされません。オーナーのWebhookが設定されている場合は通常通り発火します。詳しくは本番コンソールをご覧ください。
デプロイリクエスト通知
サンドボックスタブで表示されます。
協力者が本番デプロイをリクエストした場合に表示されます。この通知はメールでも送信されるため、見逃すことはありません。すべて表示ボタンをクリックすると、デプロイリクエストの全履歴を確認できます。
トラブルシューティング
- デプロイボタンが無効: サンドボックスでテストコールが行われていないか、最新のサンドボックスバージョンがすでに本番にデプロイ済みです。まずサンドボックスでテストを実行してください
- 本番タブにレコードがない: デプロイが完了するまで本番コールは拒否されるため、レコードは記録されません。デプロイが成功しているか、
tm_live_キーが使用されているか確認してください - 必須フィールドを変更したが本番に反映されない: サンドボックスの変更は本番に自動適用されません。再度
本番にデプロイをクリックしてください - Webhookが届かない: Webhookサーバーは7秒以内にレスポンスを返す必要があります。サーバーが公開アクセス可能でHTTPSを使用しているか確認してください。DiscordやSlackなどのプラットフォームには独自のレート制限があり、短時間に大量のWebhookが発火すると一部がブロックされる場合があります。受信プラットフォームのレート制限ポリシーも確認してください