SuperSaaSのフォームAPIでできること

フォームAPI

フォームAPIはフォームから登録された情報データベースに直接アクセスできます。

フォームから登録された情報の照会（SELECT）が可能です。

編集系（INSERT、UPDATE、DELETE）のAPIは未実装です。

照会取得のみのAPIなので、統計程度の活用になります。
開発する必要はほとんどないはずなので、是非とも編集系も実装してほしいですね！

フォームAPI（1種類）

フォームの登録情報照会API

www.supersaas.com/api/forms

フォームから登録された内容となる情報を取得できます。

例：フォームを指定して、登録された情報を取得する場合
https://www.supersaas.com/api/forms?account=アカウント名&api_key=API Key&form_id=フォームID&from=日時

例：登録データを指定して、その情報のみを取得する場合
https://www.supersaas.com/api/forms?account=アカウント名&api_key=API Key&id=登録データID

レスポンスはデフォルトでjson型ですが、APIの呼び出し方でXML型を指定することも可能です。
https://www.supersaas.com/api/forms?account=******　json型でレスポンス
https://www.supersaas.com/api/forms.xml?account=******　XML型でレスポンス
https://www.supersaas.com/api/forms.json?account=******　json型でレスポンス

コール用フィールド
（物理名）論理名	概要
（account）アカウント名	SuperSaaSアカウント名です。
（api_key） API Key	API利用認証用のAPI Keyです。
（form_id）フォームID	フォームの管理用ユーニーク番号で指定します。フォームの設定「概要」を表示した時のURLの末尾の数字がフォームIDです。レスポンスは対象フォームから登録された全ての情報となります。
（id）登録データID	フォームから登録された情報の管理用ユーニーク番号で指定します。登録情報の編集画面を表示した時のURLの末尾の数字がデータIDです。フォームから登録された情報を個別に取得する場合の引数です。
（from）取得開始日時	指定すると、その指定日時以降の情報を取得します。日時のタイムゾーンはUTCです。
（user）ユーザー指定	ユーザーを指定して情報を取得できます。指定にはユーザー名、ユーザーID、外部キーを用いることが可能です。 0を指定することでユーザーではなく管理者を指定することもできます。

公式に記載はありませんが、「limit」や「offset」も使えました！
大量のデータを扱うときとか、無いと不便ですものね。

主なレスポンスフィールド
（物理名）論理名	概要
（id）登録情報ID	フォームから登録された情報管理用のユニークな番号です。
（reservation_process_id）予約情報との関連	登録された情報が紐づく予約情報IDです。予約との紐付き設定がない場合は 0（あるいは、null）となります。
（content）フォーム情報の構成	登録された情報の内容です。
（created_on）情報登録日時	フォームで情報が登録された日時です。タイムゾーンはUTCです。
（updated_on）情報更新日時	情報がされた場合の更新日時です。タイムゾーンはUTCです。
（super_form_id）フォームID	その情報の登録にもし入られたフォームのIDです。「id」フィールドを指定して、登録情報を個別に指定した場合のみレスポンスです。
（deleted）削除フラグ	削除された情報（ゴミ箱に情報が入っている状態）の場合はtrueが返ります。「id」フィールドを指定して、登録情報を個別に指定した場合のみレスポンスです。
（user_id）ユーザーID	情報を登録したユーザーのIDです。ログインしていないなどユーザーID情報がない状態で登録された情報の場合はnullが返り、管理者による投稿の場合は0が帰ります。

Developer | Form API

Retrieve and read data captured in custom forms. This tutorial explains how to work with the form API

（物理名）論理名	概要
（account）アカウント名	SuperSaaSアカウント名です。
（api_key） API Key	API利用認証用のAPI Keyです。
（form_id）フォームID	フォームの管理用ユーニーク番号で指定します。フォームの設定「概要」を表示した時のURLの末尾の数字がフォームIDです。レスポンスは対象フォームから登録された全ての情報となります。
（id）登録データID	フォームから登録された情報の管理用ユーニーク番号で指定します。登録情報の編集画面を表示した時のURLの末尾の数字がデータIDです。フォームから登録された情報を個別に取得する場合の引数です。
（from）取得開始日時	指定すると、その指定日時以降の情報を取得します。日時のタイムゾーンはUTCです。
（user）ユーザー指定	ユーザーを指定して情報を取得できます。指定にはユーザー名、ユーザーID、外部キーを用いることが可能です。 0を指定することでユーザーではなく管理者を指定することもできます。

（物理名）論理名	概要
（id）登録情報ID	フォームから登録された情報管理用のユニークな番号です。
（reservation_process_id）予約情報との関連	登録された情報が紐づく予約情報IDです。予約との紐付き設定がない場合は 0（あるいは、null）となります。
（content）フォーム情報の構成	登録された情報の内容です。
（created_on）情報登録日時	フォームで情報が登録された日時です。タイムゾーンはUTCです。
（updated_on）情報更新日時	情報がされた場合の更新日時です。タイムゾーンはUTCです。
（super_form_id）フォームID	その情報の登録にもし入られたフォームのIDです。「id」フィールドを指定して、登録情報を個別に指定した場合のみレスポンスです。
（deleted）削除フラグ	削除された情報（ゴミ箱に情報が入っている状態）の場合はtrueが返ります。「id」フィールドを指定して、登録情報を個別に指定した場合のみレスポンスです。
（user_id）ユーザーID	情報を登録したユーザーのIDです。ログインしていないなどユーザーID情報がない状態で登録された情報の場合はnullが返り、管理者による投稿の場合は0が帰ります。