APIとWebhook
タブ
APIとWebhookページは、PlatoFormsを外部サービスと接続するためのツールを管理する場所です。フォーム送信を他のシステムにプッシュするWebhookエンドポイント、サードパーティ統合用のOAuth2アプリケーション、サーバー間API呼び出し用の長期間有効なトークンがあります。この章では、ページへのアクセス方法とそれぞれの設定方法を説明します。
APIとWebhookページへのアクセス
-
ログインしてダッシュボードにアクセスします。
-
左側のサイドバーで、チーム名をクリックしてチームメニューを開きます。
-
リストからAPIとWebhookを選択します。
権限に基づく表示内容
アクセス権がある場合
ページは直接API URL & トークンに開き、Webhook、OAuth2アプリケーション、トークンを表示および管理できます。
チーム管理者は常にこのページに直接アクセスできます。
アクセス権がない場合
APIとWebhookはロックアイコンと**「管理者にアクセスをリクエスト」**ラベルが表示されます。
管理者にアクセスをリクエストをクリックしてリクエストを送信します。
チーム管理者はリクエストの通知メールを受け取ります。アクセスが許可されると、自分のチームメニューからAPIとWebhookを開けるようになります。
Webhookエンドポイントの設定
フォームが送信されたときや他のイベントが発生したときにリアルタイム通知を受け取るためのエンドポイントを設定します。フォームデータを他のアプリケーションやサービスに統合するのに便利です。
+ エンドポイントを追加をクリックして新しいエンドポイントを作成するか、既存のエンドポイントの横にある編集アイコンをクリックして変更します。
エンドポイントを追加または編集する際には、以下を設定できます。
| フィールド | 説明 |
|---|---|
| 名前 | エンドポイントを識別するためのラベルです。 |
| WebHook URL | POSTリクエストを受け取るURLです。 |
| ターゲットフォーム | すべてのフォームを選択して任意のフォーム送信でWebhookをトリガーするか、特定のフォームを選択します。 |
| 共有可能なリンクを含める | ペイロードに共有可能な送信リンクを含めます。 |
| 送信データをDictとして（リストの代わりに） | ペイロード内の送信データの構造を変更します。 |
| インスタントフック（PDF作成を待たずに） | 送信PDFの生成を待たずにWebhookを即座に発火します。 |
| ペイロードから署名データを除外 | ペイロードから署名データを省略します。 |
| Webhook有効化 | エンドポイントを削除せずにオンまたはオフに切り替えます（既存のエンドポイントを編集する場合に利用可能）。 |
保存をクリックして変更を適用するか、削除をクリックしてエンドポイントを完全に削除します。
OAuth2アプリケーションの作成
PlatoFormsのAPIは、セキュアな認証および認可フレームワークであるOAuth2プロトコルによって保護されています。「OAuth2アプリケーション」とは、システムとやり取りするためにOAuth 2.0を利用する登録済みのアプリケーションを指します。
OAuth2アプリケーションを作成することで、認証プロセスを通じてクライアントIDとクライアントシークレットを安全に取得できます。これにより、他のアプリケーションがプラットフォームのAPIにアクセスするための安全な認可が可能になります。OAuth2アプリケーションの作成は、安全な統合のための基本コンポーネントを設定し、OAuth2を使用してAPIとやり取りするための認証と認可を可能にします。
OAuth2アプリケーションを作成するには：
-
+ アプリケーションを追加をクリックします。
-
開いたウィンドウで：
-
システム内で識別するための名前を入力します。
-
OAuth2フローに重要なリダイレクトURLを指定します。
-
-
保存をクリックして設定を確認します。
アプリケーションが保存されると、システムは一意のクライアントIDとクライアントシークレットを生成します。
トークンの作成とリセット
長期間のAPIアクセスが必要な開発者の場合、プラットフォームは非期限切れトークンを作成およびリセットする機能を提供します。この機能により、定期的なトークンの更新が不要になり、サーバー間リクエストのための中断のない長期間のAPIアクセスが保証されます。各チームには1つの非期限切れトークンがあります。
作成またはリセットをクリックしてトークンを生成し、必要に応じて削除を使用して削除します。この機能は、APIへの長期間アクセスの管理プロセスを簡素化します。
トークン、クライアントID、クライアントシークレットはパスワードのように扱ってください。これらにアクセスできる人は、あなたのチームのデータにアクセスできます。
コードを一切書かずに、AIアシスタントと対話しながらフォームを操作したい場合は、AIアシスタント（MCP）をご覧ください。