フォームAPI

ここに掲載されている内容は、開発者用の技術情報です。
掲載内容以上のサポートはできません。
ご利用にあたっては十分なご理解の上で活用ください。
SuperSaaSは開発中を含むwebhookとAPIを提供するもので、それを利用するサービス、アプリケーションに責任を持つことはできません。

フォームAPIを用いて、スタンドアローンな利用も含めたカスタムフォームを使った情報の取得が可能です。
このAPIは情報取得のもので、カスタムフォームを登録手続きの一環としての追加や、各予約に添付する場合は、ユーザーAPIアポントメントAPIを参照ください。

Authentication

認証についてはこちらを参照下さい。

フォームAPIの利用

フォームAPIの利用には2つの方法があります。
一つ目として、フォームが持つform_idを指定するとで、そのフォームのサブセットの一覧取得です。
加えて、パラメーターfromに日時を指定することで、その日時以降に登録されたフォームのサブセットのみを取得することも可能です。

管理画面にログイン中であれば、このページの左側にアカウント情報を活用した実行可能なリクエストの表示が可能になっています。
選択された条件で生成された下のコードを実際に実行して確認可能です。

選択ください
フォームが見つかりませんでした。
https://www.supersaas.com/api/forms?form_id=<form_id>&account=&api_key=<api_key>

二つ目は、指定したフォームのサブセットを単体として取得する方法です。
そのサブセットのIDを、idパラメータとしてAPIに渡して内容を取得します。

https://www.supersaas.com/api/forms?id=<id>&account=&api_key=<api_key>
このチュートリアルは、アカウントにログインした状態で閲覧している場合、そのアカウントに関連するコードスニペットとして動的に変換されて表示されます。
ログインする
This tutorial can display code snippets relevant to your account if you generate an API Key at the bottom of the Account Info page by clicking the Generate button.

下の表は、APIへ送るURLパラメーターとして使用できる一例です。

入力パラメーター
パラメーター概要
form_id対象となるフォームIDです。
このIDは、フォームの設定 > 概要をブラウザで開いた時のURLの末尾にある番号です。
id対象フォームのサブセットIDです。
このIDは、フォームの管理にある一覧から確認できますし、webhookを用いたり、対象を実際にダウンロードすることで取得することも可能です。
from情報の取得の日時情報です。
YYYY-MM-DD HH:MM:SS形式のUTCで指定し、その日時以降の予約を対象とします。
(省略可能なパラメータ)
api_keyフォームが属するアカウントの管理者APIキー。 このフィールドを省略して、代わりにHTTP基本認証またはMD5ハッシュを使用することもできます。

リクエストが成功すると、フォームのサブセット情報が一覧として、JSON形式でレスポンスされます。

[
  {
    "id": 12345,
    "reservation_process_id": 67890,
    "content": {
      "1": "field 1",
      "2": "field 2"
    },
    "created_on": "2017-03-15T00:00:00Z",
    "updated_on": "2017-03-15T00:00:00Z",
    "user_id": 0
  },
  {
    "id": 23456,
    ...
  }
]

単一のサブセットを取得する場合は、次のようなレスポンスです。

{
  "id": 12345,
  "reservation_process_id": 67890,
  "content": {
    "1": "field 1",
    "2": "field 2"
  },
  "created_on": "2017-03-15T00:00:00Z",
  "updated_on": "2017-03-15T00:00:00Z",
  "super_form_id": 34567,
  "deleted": false,
  "user_id": 0
}

下の表は、レスポンスされるJSON形式のフィールド情報です。

レスポンスフィールド
フィールド概要
idフォームのサブセットIDです。
reservation_process_idフォームに関連する予約IDです。
フォームがユーザーに帰属している場合や、他との関連性のないスタンドアローンなフォームである場合は、 0 、もしくは、 null が返ります。
contentフォームのサブセットを形成する各フィールド情報です。
created_on対象フォーム情報が登録されたUTCの日時です。
updated_on対象フォーム情報の更新されたUTCの日時です。
super_form_idサブセットが帰属するフォームIDです。
(フォームのサブセットを指定した単一取得の場合のみ).
deleted情報の削除フラグです。
削除されている情報の場合 true が返ります。
(フォームのサブセットを指定した単一取得の場合のみ)
user_idフィールドの情報を登録したユーザーIDです。
ユーザーがログインしていないなど特定されない場合は null が、管理者が作成した場合は 0 が返ります。