スパイラル サポートサイト

powered by SPIRAL PLACE®

HOME > 機能 > ハイレベルAPI>area(マイエリア)

area(マイエリア)


マイエリアとは、会員専用のマイページの集まりのことです。マイエリア機能を用いることで、CGI などのプログラムを必要とすることなく、会員専用ページや会員専用アンケート、会員情報変更ページ等を構築できます。詳しくはマイエリアを参照下さい。


area/login


マイエリアにログインします。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
my_area_titleマイエリアのタイトル半角英数字, アンスコ, ハイフン 16文字以内
id会員識別キーマイエリア設定に基づく
key自動発行キーマイエリア設定に基づく
passwordパスワードマイエリア設定に基づく
url_typeURLのパスを「/area/」or「/area/afp/」か選択できる。
0:/area/
1:/area/afp/
2:レスポンスのurlにjsessionidが付かない(urlのパスは0の時と同じ)
指定がない場合や、上記以外の値が指定された場合は、0が使用される。
int (0 or 1 or 2)
auto_login自動ログインフラグ
f:自動ログインしない
T:自動ログインする
指定がない場合や、上記以外の値が指定された場合は、fが適用される。
boolean


レスポンス


パラメータ説明文字種長
code応答コードint 0以上1000未満
message応答メッセージ半角英数字記号
jsessionidマイエリアに接続したセッションID半角英数大文字
urlログイン成功時はログイントップ画面のURL
マイページのURL場合、(https://FQDN/..../area.MyPageBundle・・・)
url_typeが0の時は、....部分が/area/のパスのURL
url_typeが1の時は、....部分が/area/afp/のパスのURL
url_typeが2の時は、....部分が/area/のパスでjsessionidが付かないURL
URL仕様
auto_login_cookieマイエリアに自動ログイン設定がされており、ログイン時リクエストパラメータ
auto_loginがtで送信された場合、自動ログインに使用するCookie情報として返却される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int


area/logout


マイエリアからログアウトします。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のauto_login_cookieの値半角英数字記号
my_area_titleマイエリアのタイトルint


レスポンス


パラメータ説明文字種長
code応答コードint 0以上1000未満
message応答メッセージ半角英数字記号
urlログアウト後に遷移するURL。存在しないマイエリアを指定した場合は空文字。URL仕様
jsessionid有効なセッションのID半角英数字
auto_login_cookieリクエストにauto_login_cookieが送信されている場合に返却されるCookie削除用半角英数字記号
auto_login_limitログアウト時は常に0が返却されるint


area/status


ログイン状態を確認し、ログインセッションが有効な場合はセッション有効期間を延長します。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
my_area_titleマイエリアのタイトルint


レスポンス


パラメータ説明文字種長
code応答コードint 0以上1000未満
message応答メッセージ半角英数字記号
jsessionidマイエリアにログインした際のセッションID半角英数字, アンスコ, ハイフン 16文字以内
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが送信された場合で
自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int
statusステータスコード。0 = ログインしていない, 1 = ログインしているint (0 or 1)


area/mypage


マイエリアのカスタムマイページのURLを取得します。
○:必須、△:選択必須


リクエストパラメータ


パラメータ必須説明文字種長
spiral_api_tokenAPIトークン半角英数字
passkeyepoch秒。APIトークンシークレットとpasskeyで署名を作成する。
署名の有効期限チェックにも使用する。有効期限は作成してから30分。
int
signature署名半角英数字
jsessionidマイエリアにログインした際のセッションID半角英数大文字
auto_login_cookieマイエリアにログインした際のaluto_login_cookieの値半角英数字記号
my_area_titleマイエリアのタイトルint
my_page_idマイページ番号int
url_typeURLのパスを「/area/」or「/area/afp/」か選択できる。
0:/area/
1:/area/afp/
指定がない場合や、上記以外の値が指定された場合は、0が使用される。
int (0 or 1)


レスポンス


パラメータ説明文字種長
code応答コードint
message応答メッセージ半角英数字記号
urlマイページのURL場合、(https://FQDN/..../area.MyPageBundle・・・)
url_typeが0の時は、....部分が/area/のパスのURL
url_typeが1の時は、....部分が/area/afp/のパスのURL
URL仕様
jsessionid有効なセッションのID半角英数字
auto_login_cookiejsessionidが送信されない、もしくは無効なjsessionidが送信された場合で
自動ログインが成功した場合、有効な自動ログイン用のCookieが返される。
半角英数字記号
auto_login_limitauto_login_cookieにより自動ロクインできる有効期限のエポック秒int

フロー・操作画面と各パラメータの関連性


以下はフローにおいて各パラメータが何を指すのかを示しています。

パラメータとの関連性

以下は操作画面において各パラメータが何を指すのかを示しています。




サンプルプログラム



最終更新日:2020/10/19