SPIRAL PLACE APIを利用すると、SPIRAL PLACEアカウントのユーザー情報、グループウェア情報を利用した様々なアプリケーションを開発することができます。
例:SPIRAL PLACE上に登録されたメールアドレスを取得し、自社システムへの登録を行うアプリ など
本ドキュメントでは、APIを利用してSPIRAL PLACEのデータを取得、変更等を行う方法を説明します。
注意事項
API・アプリを利用できるロールについて
アドミン(スタッフ) | スタッフ | ゲスト | |
---|---|---|---|
APIの利用 | ○ | ○ | × |
アプリの利用 | ○ | ○ | × |
アプリの利用権限について
スタッフプレースでアプリを登録した際に、アプリは登録した時点で設定した「アカウント」に
リソースとして所属します。
ユーザーは登録したアプリに対して「閲覧」「編集」「削除」の権限を付与されている状態と
なります。
利用権限の移譲
他のユーザーに「閲覧」「編集」「削除」の権限を移譲することができます。
※移譲処理を行ったユーザーは、移譲処理後「閲覧」「編集」「削除」の処理を行うことができなく
なります。
利用権限の強制移譲
ユーザーに対して以下の処理を行った際に、ユーザーに紐づいているアプリは「アプリに紐づいているアカウント」の管理者に強制的に利用権限を移譲されます。
※アカウント管理者を変更した場合、変更した時点で所有権を保持しているアプリはそのままと
なります。
- ユーザー退会時(スタッフプレースからの退会時)
- アドミンプレースからアプリを作成しているユーザーをゲストロールに変更時
- アドミンプレース(アカウント)からユーザー除外時
なお、任意・強制に関わらず、移譲した際には移譲されたユーザーに対して移譲された旨の通知メールが送信されます。
アプリについて
アプリの作成数上限
1アカウントにつき、「10」アプリまで作成が可能です。
アプリの強制停止
アドミンプレースから強制的にアプリの利用停止を行うことが可能です。
APIのリクエストエラーについて
APIのリクエストには「30秒」の実行制限期間が設けられています。
上記の実行制限期間を過ぎると、以下サンプルの値がレスポンスとして返されます。
サンプル
{"code":408,"reason":"API execution time has reached the limit.","message":"408 equest Time-out"}