サイト認証API
機能概要
サイト認証APIとは、サイトで作成した認証エリアに対して、API経由でログインすることができる機能です。
サイト認証APIでは、以下の特徴があります。
・サイト認証APIを使用して、認証エリアへログインをすることができます。
・ログインセッションの有効性の確認や維持時間の延長が可能です。
・サイト認証APIのログインセッションを利用して、SPIRAL ver.2で提供されているサイト機能の認証エリアにもログインすることができます。
（サイト認証APIと認証エリアでログインセッションを共有することができます。）
APIの記述方法についてはサンプルプログラムやAPIリファレンスをご参照ください。
クライアントプログラム実装時には事前にDBや認証エリアの設定が必要です。設定の流れについてはこちらをご覧ください。
機能仕様
サイト認証APIでは、以下の機能を提供します。
【シークエンス図】
1. ログイン認証API
・IDとパスワードの認証情報を用いて本番環境の認証エリアにログインし、ログインセッションに紐づくエリア認証トークンを発行します。
・エリア認証トークンの有効期限は認証エリアで設定したログインセッション有効期限に準じます。
2. トークンの有効性確認API
・ログインセッションに紐づくエリア認証トークンの有効性を確認します。
・指定するエリア認証トークンを発行したAPIエージェントのみ使用可能です。
・デフォルトで有効性確認と同時にログインセッションの有効期限を延長します。
3. ワンタイムURL発行API
・有効なエリア認証トークンを用いて認証エリアにブラウザでログインするためのワンタイムURLを発行します。
・ワンタイムURLは一度アクセスすると無効化され再アクセスできなくなります。
・同じ認証トークンでURLが複数発行された場合は最後に発行されたものだけが有効となります。
・ワンタイムURLの有効期限は発行されてから1分間となります。
・ワンタイムURLでアクセスした先の認証エリアでログアウトした場合はエリア認証トークンは無効となります。
・指定するエリア認証トークンを発行したAPIエージェントのみ使用可能です。
4. ログアウトAPI
・本番環境の認証エリアからログアウトします。
・ログアウトするとエリア認証トークンは無効となります。
・ワンタイムURLで認証エリアにログインしている場合もログアウトされます。
・指定するエリア認証トークンを発行したAPIエージェントのみ使用可能です。
管理権限
サイト認証APIは、サイト認証APIの利用権限にて許可されたAPIエージェントのAPIキーでのみ実行できます。
ユーザのAPIキーでは実行できませんのでご注意ください。