メニュー経路: ダッシュボード > API > 新規API作成

新規エンドポイント作成

概要

エンドポイントとは、外部システムからJSONデータを受信できるURLです。3Min APIは受信データを保存し、ログを記録し、オプションでWebhookで転送します。

このページでは、名前、説明、および任意の必須フィールドを入力するだけでエンドポイントを作成できます。必須フィールドは後から詳細ページで変更できるため、最初はスキップしても構いません。

基本情報の入力

必須項目です。

エンドポイントを区別するためのユーザー向けの名前です
実際のAPIパス（スラッグ）は自動生成されるため、データの性質を反映する名前を選んでください
- 良い例: contact-form、order-notification、wine-shop-sale
- 避けるべき例: test、api1、my endpoint
制約事項:
- 空にはできません
- 同じアカウント内で一意である必要があります
- 最大文字数の制限があります（超過するとエラーメッセージが表示されます）

任意項目です。

任意です。後からいつでも詳細ページで追加できます。

必須フィールドエディタ

APIコールに必ず含めなければならないJSONフィールドを事前に定義します。定義されたフィールドがリクエストに含まれていない場合、コールは拒否されます。

JSONにキーが存在するかどうかのみをチェックします。値の内容やフォーマットは検証しません。

必須フィールドを定義しない場合、エンドポイントはあらゆるJSONペイロードを受け入れます。まずエンドポイントを作成し、サンドボックスでテストし、必要なフィールドを把握してから、エンドポイント詳細ページで追加してください。

API作成をクリックすると、エンドポイント詳細ページに自動的に遷移します。そこから続けてください:

名前は後から変更できますか？ — はい、詳細ページの概要でいつでも編集できます。説明も同様です
複数のエンドポイントが必要ですか？ — ほとんどの場合、不要です。3Min APIはドキュメント型ストレージを使用しているため、ネストされたJSONを1つのペイロードとして単一のエンドポイントに送信できます。イベントが根本的に異なる場合（例: 注文と問い合わせ）のみ、エンドポイントを分けてください
厳密な必須フィールドを定義すべきですか？ — 最初は定義せず、協力者とテストしてから、本当に常に必要なフィールドのみを追加することをお勧めします