APIプレイグラウンド

タブ

APIプレイグラウンドでは、特定のフォームに対してPlatoFormsのREST APIをテストでき、そのフォームの実際のデータと自動入力されたAPIトークンを使用します。エンドポイントを選択し、複数の言語で実行可能なコードサンプルを確認し、自分でコードを書くことなくライブリクエストを実行できます。このガイドでは、プレイグラウンドへのアクセス方法とエンドポイントの探索方法を説明します。

APIプレイグラウンドへのアクセス

ダッシュボードで目的のフォームにカーソルを合わせ、右上の設定（ギア）アイコンをクリックします。
フォームを管理をクリックしてフォームの設定を開きます。
左側のサイドバーで、接続の下にあるAPIプレイグラウンドを選択します。

前提条件

フォームでAPIプレイグラウンドを使用するには、次の要件を満たす必要があります。

フォームが公開されていること。
フォームに少なくとも1件の送信があること。
チームが無料トライアルまたは有料プランに加入していること。
メールアドレスが確認済みであること。

これらのいずれかがまだ満たされていない場合、ページにはいくつかのことを最初にと表示され、各要件が満たされているかどうかが示され、満たされていない場合はその理由（例：「まだ送信が記録されていません。」）が表示されます。

チームがアカウントにAPIアクセスを許可していない場合、チームのカードにアクセスをリクエストボタンが表示されます。それをクリックしてチーム管理者に通知します。

Note

要件は自動的にチェックされます。すべてが満たされると、ページはライブプレイグラウンドに変わります。更新や移動は不要です。

すべてが満たされると、ページの上部にフォームのAPIトークンが表示され、以下のリクエストで使用する準備が整います。

APIエンドポイントの探索

APIプレイグラウンドは、主要なAPIエンドポイントのほとんどをコーディングなしでテストする機能を提供します。エンドポイントはカテゴリごとにグループ化されています。フォーム、フォームズ、招待、Me、送信などです。

探索するAPIエンドポイントを選択をクリックし、ドロップダウンリストからエンドポイントを選択します。各エンドポイントは、そのHTTPメソッド（例：GET）、その機能の簡単な説明、および呼び出すルート（例：GET /v4/form/{form_id}/）を示します。

Note
各エンドポイントの詳細については、APIドキュメントボタンを通じてAPIドキュメントを参照してください。
プログラミングに精通している場合は、Curlを使用したシェルコマンド、Python、JavaScript、Java、またはGolangなど、さまざまな言語で提供されるサンプルコードをコピーできます。フォームのAPIトークンはすでに入力されているため、リクエストはそのまま実行可能です。
テストを実行をクリックしてリクエストを行い、レスポンスを生成します。

リクエストが完了すると、レスポンスにはHTTPステータスコードとリクエストにかかった時間が表示され、返されたJSONが表示されます。レスポンスにURLが含まれている場合は、その機能をテストするためにクリックしたり、リンクをたどって送信されたフォームを表示したりできます。