サイト認証APIで必要な設定情報
目次
機能概要
サイト認証APIを利用するクライアントプログラムの実装においては、
サイトIDと認証エリアIDの情報が必要になるため、ここでは必要な設定情報について説明します。
リクエストサンプル（ログイン認証）
| End Point |
POST https://api.spiral-platform.com/v1/sites/{siteId}/authentications/{authenticationId}/login |
|---|---|
| PARAMETERS |
必須：サイトIDと認証エリアIDの指定が必要となります End Pointの{siteId}にはサイトIDを、{authenticationId}には認証エリアIDを指定してください。
|
| REQUEST BODY |
|
その他のサイト認証APIの機能についてはサンプルプログラムやAPIリファレンスをご参照ください。
設定の流れ
以下の流れで設定し、サイトIDと認証エリアIDを取得します。
1. APIエージェントの追加
APIエージェントを追加します。
詳しくはこちらをご参照ください。
2. アプリを作成
アプリを作成します。
詳しくはこちらをご参照ください。
3. DBを作成
認証エリアを作成するDBを作成します。
詳しくはこちらをご参照ください。
4. サイト作成
サイトを作成します。
詳しくはこちらをご参照ください。
5. 認証エリアを作成
認証エリアを作成します。
詳しくはこちらをご参照ください。
認証エリアは作成後に本番環境へリリースしてください。
6. グループの権限設定
作成した認証エリアとAPIエージェントをグループに所属させます。
グループについてはこちらをご参照ください。
アカウント管理左メニューの「グループ」より権限を追加したいグループを選択し、「APIエージェント」タブよりAPIエージェントを追加します。
「サイト認証API」タブより認証エリアを追加します。
※本番環境リリースされている認証エリアのみ追加可能です。
設定後のIDの確認方法
サイトID（siteId）の確認
サイトIDはサイトの基本設定画面でご確認頂けます。
認証エリアID（authenticationId）の確認
認証エリアIDは認証エリアの詳細画面でご確認頂けます。
