3Min API

クイックスタート

たった3分で完了。アカウント登録から最初のAPIテストまで。

1. アカウント登録

Googleで簡単に開始できます。月1,000回のAPIリクエストが無料。

2. エンドポイント作成

1
ダッシュボード → API → 新規エンドポイントボタン
2
API名を入力
  • 説明は任意
3
オプション設定
  • 必須フィールド
    • 特定のフィールドを必須に設定。欠落したリクエストは拒否されます。
    • 文字列フィールドはログフィルタリング用に検索可能に設定可能。
  • Webhook
    • SlackやDiscordなどの外部サービスにデータを転送。
    • 協力者のWebhookとは別 — これはご自身の連携用です。
4
API作成をクリック
  • エンドポイントURLとCRUDメソッド（POST/GET/PUT/DELETE）が即座に生成
  • デフォルトAPIキーが自動発行（サンドボックスキーはすぐに使用可能、本番キーはデプロイ後に利用可能）
  • 組み込みテストページも作成 — 追加ツール不要

3. テスト: 最初のAPIコールとログ確認

エンドポイント作成後すぐにテストし、ログで受信を確認します。

ダッシュボード → API → エンドポイント詳細 → テスト開始ボタン
  • サンドボックス環境で実際のAPIコールをテスト
ダッシュボード → ログ
  • データが正しく保存されていることを確認
  • ログの表示に最大3秒かかる場合があります

4. コラボレーションキー作成＆メールで協力者招待

オーナーのテスト完了後、コラボレーションキーを作成してメールで協力者を招待します。

ダッシュボード → API → エンドポイント詳細 → コラボレーションキー → すべて表示
  • 「追加」をクリックしてコラボレーションキーを作成
  • コラボレーションキーの詳細ページからメール招待を送信
  • 招待された協力者はアカウント登録後、自分のダッシュボードからAPIキー、ログ、統計を確認可能

5. 連携テスト

協力者がサンドボックスでAPIを正しくコールできることを確認します。

  • 協力者がエンドポイント詳細ページでサンドボックスAPIキーを確認
  • 協力者がサンドボックス環境でAPIをテスト
  • ダッシュボード → ログでリクエストデータの受信を確認

6. 本番にデプロイ

テスト完了後、本番にデプロイします。オーナーが直接デプロイするか、協力者のデプロイリクエストを承認します。

ダッシュボード → API → エンドポイント詳細 → 本番にデプロイボタン
  • 協力者がエンドポイント詳細ページの「デプロイリクエスト」ボタンからデプロイを依頼
  • オーナーは直接デプロイするか、協力者のリクエストを確認して承認
  • デプロイ後、協力者に自動通知され本番APIキーにアクセス可能に