インフォメーションAPI
掲載内容以上のサポートはできません。
ご利用にあたっては十分なご理解の上で活用ください。
SuperSaaSは開発中を含むwebhookとAPIを提供するもので、それを利用するサービス、アプリケーションに責任を持つことはできません。
インフォメーションAPIを用いて、アカウント内のスケジュールやフォームを一覧として取得できます。
また、サービススケジュールのサービスや、リソーススケジュールのリソースの一覧を取得や、登録可能なフィールド情報を取得することも可能です。
API認証
認証についてはこちらを参照下さい。
アカウント内のスケジュール、フォームの取得
対象がスケジュールの場合は/api/schedule、フォームの場合は/api/super_formsをコールして、アカウント内のスケジュール、またはフォームの一覧を取得できます。
実行認証として、アカウント名とパスワードをURLパラメータ、もしくは、基本認証として渡す必要があります。
例
https://www.supersaas.com/api/schedules.json?account=accountname&api_key=api_key
https://www.supersaas.com/api/super_forms.json?account=accountname&api_key=api_key
APIから、IDや名前などのフィールド情報がタプルな配列でレスポンスされます。
スケジュールを指定してリソース、サービスの取得
www.supersaas.com/api/resourcesにパラメーターを載せてHTTP GETリクエストします。
| パラメーター | 概要 |
|---|---|
schedule_id | 対象スケジュールIDです。 このIDは、スケジュールの設定 > 概要をブラウザで開いた時のURLの末尾にある番号です。 |
例
https://www.supersaas.com/api/resources.json?schedule_id=999999&account=accountname&api_key=api_key
APIから、リソース、もしくはサービスのIDや名前をなどのフィールド情報がタプルな配列でレスポンスされます。
リソース、サービスが対象のため、定員制スケジュールでこのAPIを使用することはできません。
APIの末尾に.xmlまたは.jsonを指定することで、レスポンス形式をJSON、XMLから選択できます。
登録可能なフィールド情報の取得
www.supersaas.com/api/field_listにパラメーターを載せてHTTP GETリクエストします。
schedule_idパラメーターを省略することで、対象がスケジュールではなく、ユーザーとなります。
| パラメーター | 概要 |
|---|---|
schedule_id | このIDは、スケジュールの設定 > 概要をブラウザで開いた時のURLの末尾にある番号です。 (省略可能なパラメーター) |
例
プレースホルダデータを表示する
https://www.supersaas.com/api/field_list.json?schedule_id=999999&account=accountname&api_key=api_key
APIはJSON形式で、IDや作成日など対象のフィールド情報の一覧をレスポンスします。
ユーザーグループの一覧を取得
www.supersaas.com/api/groupsにパラメーターを載せてHTTP GETリクエストします
例
https://www.supersaas.com/api/groups?account=accountname&api_key=api_key
APIから、グループIDや名前のフィールド情報がタプルな配列でレスポンスされます。
→ ログインする