APIとWebhook
タブ
この章は、APIとWebhookページを使用する開発者向けのガイドです。これらのツールを活用するための洞察を得ることができます。
APIとWebhookページにアクセスする
-
ダッシュボードにログインします。
-
ダッシュボードの右上隅にあるプロフィール写真をクリックし、API Webhooksを選択します。
APIアクセスのステータスを確認する
開いたページで、APIアクセスのステータスを確認できます。
Webhookエンドポイントを設定する
フォームが送信されたときや他のイベントが発生したときにリアルタイム通知を受け取るためのエンドポイントを設定します。フォームデータを他のアプリケーションやサービスに統合するのに便利です。
+ エンドポイントを追加をクリックして新しいエンドポイントを作成するか、既存のエンドポイントを変更するには編集をクリックします。
OAuth2アプリケーションを作成する
PlatoFormsのAPIは、OAuth2プロトコルによって保護されています。これは、安全な認証と認可のフレームワークです。「OAuth2アプリケーション」とは、システムとやり取りするためにOAuth 2.0を利用する登録済みのアプリケーションを指します。
OAuth2アプリケーションを作成することで、認証プロセスを通じて安全にクライアントIDとクライアントシークレットを取得できます。これにより、他のアプリケーションがプラットフォームのAPIにアクセスするための安全な認可が可能になります。‘OAuth2アプリケーション’の作成は、安全な統合のための基本的なコンポーネントを設定し、OAuth2を使用した認証と認可の両方でAPIとやり取りすることを可能にします。
OAuth2アプリケーションを作成するには:
-
+ アプリケーションを追加をクリックします。
-
開いたウィンドウで:
-
システム内で識別するためのアプリケーション名を入力します。
-
OAuth2フローに不可欠なリダイレクトURLを指定します。
-
-
保存をクリックして設定を確認します。
アプリケーションが保存されると、システムは一意のクライアントIDとクライアントシークレットを生成します。
トークンの作成とリセット
長期間のAPIアクセスを必要とする開発者の場合、プラットフォームは有効期限のないトークンを作成およびリセットする機能を提供します。この機能により、定期的なトークンの更新が不要になり、途切れない長期的なAPIアクセスが保証されます。
単にトークンを作成またはリセットをクリックして新しいトークンを生成し、必要に応じて既存のトークンを削除するには削除を使用します。この機能により、APIへの長期アクセスの管理プロセスが簡素化されます。