テスト＆連携ガイド
概要
エンドポイント詳細ページでテスト開始をクリックすると開くページです。追加ツールなしでブラウザから直接APIコールをテストでき、協力者と共有すれば連携に必要な情報をすべて1か所で確認できます。
このページでのテストはサンドボックス環境のみで行われます。本番データには影響しないため、自由に試してください。
ページには2つのタブがあります:
- クイックスタート — APIキーで認証し、すぐにコールをテストします
- ガイド — オーナーと協力者のための連携リファレンス（ステップガイド、APIエンドポイント、ヘッダー、フィールド定義、コード例など）
このページへのアクセス方法
- エンドポイント詳細右サイドバー > テスト開始ボタン（サンドボックスタブ）
- 協力者も招待承諾後、自身のダッシュボードからアクセスできます
エンドポイント情報
- エンドポイント名と説明が表示されます
- 環境バッジ（サンドボックス）とバージョン情報が並んで表示されます
- クイックスタート / ガイドタブを切り替えます
クイックスタートタブ
認証
テストを開始するには、まずAPIキーで認証する必要があります。
- サンドボックスキー（
tm_test_で始まるもの）を入力欄に貼り付けて認証をクリックします - 2種類のキーが使用できます:
- デフォルトAPIキー — オーナーが直接テストする場合
- コラボレーションキー — 協力者が自身のキーでテストする場合
認証が完了すると入力欄が消え、ログアウトボタンが表示されます。別のキーでテストするには、ログアウトしてから再度認証してください。
試してみる
認証後、CRUDコール実行エリアが有効になります。メソッドを選択し、リクエストボディ（JSON）を入力して実行をクリックすると、すぐに結果が表示されます。
フルフローを一度にテストしたい場合は、以下の順序で行ってください:
CRUD全テストガイド
CREATE (POST) — リクエストボディにテストJSONを入力して実行します。レスポンスから
idをコピーしてください。次のステップで使います。READ (GET) — レコードIDフィールドに
idを貼り付けて実行します。先ほど作成したデータが正しく返されることを確認します。UPDATE (PUT) — 同じ
idを入力し、変更したJSONをリクエストボディに入力します。これは完全置換なので、変更するフィールドだけでなく保持したいフィールドも含めてください。DELETE — 同じ
idを入力して実行します。その後、READを再度試してレコードが削除されたことを確認します。
権限チェック: コラボレーションキーでテストする場合、そのキーの権限で許可されたメソッドのみ実行できます。権限のないメソッドを呼び出すと403エラーが返されます。権限はコラボレーションキー > 権限で確認してください。
協力者Webhook
「試してみる」セクションの下部に、折りたたみ可能なWebhook設定エリアがあります。これはオーナーがダッシュボードで設定するWebhookとは別のもので、APIコーラーがリクエストヘッダーにWebhook情報を含めることで、指定したURLに処理結果を受信するためのものです。ここでこれらのヘッダーをテストできます。
- オーナーのWebhookとは独立して動作します
- 実際の連携では、Webhookヘッダーは直接APIコールコードに含めます
- 詳しいヘッダー名と実装方法はガイドタブのWebhook設定セクションをご覧ください
ガイドタブ
ガイドタブは、オーナーと協力者の両方が連携フロー全体と技術的な詳細を1か所で確認できるように構成されています。上部にロール別のステップガイド、その下に技術リファレンスが続きます。
はじめに — オーナー
エンドポイントを作成した方タブを選択すると、オーナーの視点からのステップが表示されます。
- エンドポイント作成 — API名を設定するだけでCRUDが自動作成されます。説明と必須フィールドは後から追加可能です
- サンドボックステスト＆ログ確認 — クイックスタートタブでデフォルトAPIキーを使ってコールし、ダッシュボードのログでデータ受信を確認します
- コラボレーションキー作成＆招待 — キーを作成し、詳細ページからメール招待を送信します
- 連携テスト — 協力者がサンドボックスで正しくコールしていることをログで確認します
- 本番デプロイ — 協力者のデプロイリクエストを承認するか、直接デプロイします。デプロイ後に協力者に通知されます
はじめに — 協力者
招待された方タブを選択すると、協力者の視点からのステップが表示されます。
- 招待を承諾 — 招待メールを確認し、ログイン後にダッシュボードで承諾します
- APIキーを確認 — エンドポイント詳細ページでサンドボックスAPIキー（
tm_test_）を確認します - 連携＆テスト — クイックスタートタブでコールをテストし、ガイドタブの技術情報を参照して連携を構築します。202レスポンスを受信すれば、以降の処理はシステムが保証します
- デプロイリクエスト — テスト完了後、エンドポイント詳細ページからデプロイリクエストを提出します
- 本番環境に切り替え — オーナーがデプロイを完了すると通知されます。本番タブで本番APIキー（
tm_live_）を確認して適用します
APIエンドポイント
このエンドポイントで使用可能なAPIパスとメソッドを表示します。エンドポイント作成時に4つのメソッドが自動的に準備されます。
| メソッド | パス | 説明 |
|---|---|---|
| POST | /api/v1/data/{slug} |
新しいレコードを作成 |
| GET | /api/v1/data/{slug}/{record_id} |
レコードを取得 |
| PUT | /api/v1/data/{slug}/{record_id} |
レコードを置換 |
| DELETE | /api/v1/data/{slug}/{record_id} |
レコードを削除 |
{slug}はエンドポイント作成時に自動的に割り当てられる一意の識別子です。実際の値はこのページで確認できます。
APIキー
APIコール時の認証に使用するキー情報です。
| 環境 | キープレフィックス | 用途 |
|---|---|---|
| サンドボックス | tm_test_ |
開発・テスト |
| 本番 | tm_live_ |
本番サービス |
本番APIキーは、デプロイ完了後にエンドポイント詳細ページで確認できます。デプロイ前は、本番キーでのコールは拒否されます。
リクエストヘッダー
APIコールに含めるHTTPヘッダーです。Content-TypeとAuthorizationは必須です。Webhookヘッダーは必要な場合のみ追加します。
| ヘッダー | 必須 | 説明 |
|---|---|---|
Content-Type |
必須 | application/json（POST/PUT用） |
Authorization |
必須 | Bearer {API_KEY}形式 |
X-Webhook-Callback |
任意 | コーラーWebhookを受信するURL |
X-Webhook-Auth |
任意 | Webhook認証値（例: Bearer token） |
X-Webhook-Auth-Header |
任意 | Webhook認証ヘッダーキー（デフォルト: Authorization） |
リクエストボディ
POST/PUTリクエストで送信するJSONボディに関する情報です。
- 形式: JSON（
application/json）· 最大100KB · UTF-8 - オーナーが必須フィールドを定義している場合、それらのフィールドを含める必要があります。必須フィールド以外の追加フィールドは自由に送信できます
- 必須フィールドが定義されていない場合、任意のJSONが受け入れられます
- リクエストは非同期で処理されます。即座に202レスポンスが返り、実際の保存とWebhook配信はバックグラウンドで行われます
レスポンス形式
各メソッドの成功レスポンスとエラーコードを表示します。
成功レスポンス:
- POST/PUT/DELETE →
202 Accepted（リクエスト受理、キューに追加） - GET →
200 OK（データを即座に返却）
エラーコード:
| コード | ステータス | 意味 |
|---|---|---|
| 400 | Bad Request | 不正なJSON、必須フィールドの欠如、無効なレコードID |
| 401 | Unauthorized | APIキー未設定または無効 |
| 403 | Forbidden | エンドポイント無効、サブスクリプションなし、権限不足 |
| 415 | Unsupported Media Type | Content-Typeがapplication/jsonでない |
| 429 | Too Many Requests | 月間使用量制限超過 |
| 5xx | Server Error | 一時的なサーバーエラー — リトライロジックを実装してください |
5xxエラーを受信した場合、リクエストはサーバーに到達していません。コードにリトライロジックを実装してください（例: 1秒 → 2秒 → 4秒バックオフ）。202レスポンスを受信した場合、以降の処理はシステムが保証します。
Webhook設定
処理結果を自動的に受信するためのコーラーWebhookの設定手順です。これはオーナーのダッシュボードWebhookとは別に、独立して動作します。
設定方法: APIコールに以下のヘッダーを含めます。
| ヘッダー | 必須 | 説明 |
|---|---|---|
X-Webhook-Callback |
必須 | Webhookを受信するURL |
X-Webhook-Auth |
任意 | 認証値（例: Bearer token） |
X-Webhook-Auth-Header |
任意 | 認証ヘッダーキー（デフォルト: Authorization） |
リトライポリシー:
- 失敗時は最大3回リトライ（1〜2秒バックオフ）
- 成功条件: 2xxステータスコード
- 3回すべて失敗しても、データは安全に保存されています。ログでWebhookステータスを確認してください
コード例
curl、JavaScript、Pythonなど主要な言語でのAPIコールコードサンプルが提供されます。タブを切り替えて各言語の例を確認できます。実際のエンドポイントURLと必須ヘッダーが事前入力されているため、コピーしてそのまま使用できます。
トラブルシューティング
- 「認証」をクリックしても何も起こらない: APIキーが
tm_test_（サンドボックスキー）で始まっているか確認してください。本番キー（tm_live_）はこのページでは使用できません - CREATE後にIDを失った: もう一度CREATEを実行して新しいレコードを生成し、テストを続けてください。以前のレコードのIDが必要な場合は、ダッシュボードのログページでコール履歴を確認してください
- 403エラーが出る: 使用しているコラボレーションキーにそのメソッドの権限がない可能性があります。コラボレーションキー > 権限で確認してください
- Webhookが届かない: Webhookサーバーは7秒以内にレスポンスを返す必要があります。公開アクセス可能でHTTPSを使用しているか確認してください。DiscordやSlackにはレート制限があり、短時間に大量のWebhookが発火するとブロックされる場合があります