タグ別アーカイブ: JavaScript

パスワードを再設定する(ログインID)

ログインIDに基づいて、パスワードの再設定用URLが記載されたメールを送信します。

基本仕様

アピアリーズの会員パスワードの再設定再設定用URLが記載されたメールを、指定されたログインIDに紐付いたアドレスに送信します。

管理画面の会員管理 / 基本設定にて、ログインID認証を利用する、メールアドレスの利用を利用するに設定されている必要があります。パスワード再設定のお知らせのメールに記載されているURLをクリックすることで、パスワードの再設定をすることができます。

HTTPメソッド

POST

エンドポイント

/v1/usr/{データストアID}/{アプリID}/_self/loginId/resetPassword

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*1) アプリトークンを指定ください。
Content-Type application/json

クエリ

キー 必須 説明
access_token △(*1)
proc reissue を指定してください

(*1)〜X-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定。

コンテント

キー 必須 説明 データ型 備考
login_id ログインID String

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

HTTPステータス

ステータスコード 説明
204 正常終了
400 不正なリクエスト内容
401 トークン未指定。認証失敗
403 login_idと紐付いているメールアドレスの認証ができていない。基本設定の「メールアドレスの利用」が「利用する」になっていない。またはアクセス権限がない
404 指定されたlogin_idが見つからない。またはlogin_idと紐づくメールアドレスがnull
422 コンテント不適切
500 APIサーバエラー

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。

リクエストサンプル

レスポンスサンプル

例)Curlコマンド

関連ドキュメント

パスワードを再設定する(email)

パスワードの再設定用URLが記載されたメールを送信します。

基本仕様

アピアリーズの会員パスワードの再設定再設定用URLが記載されたメールを指定されたアドレスに送信します。

管理画面の会員管理 / 基本設定にて、メールアドレス登録を設定するに設定されている必要があります。パスワード再設定のお知らせのメールに記載されているURLをクリックすることで、パスワードの再設定をすることができます。

HTTPメソッド

POST

エンドポイント

/v1/usr/{データストアID}/{アプリID}/_self/resetPassword

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*1) アプリトークンを指定ください。
Content-Type application/json

クエリ

キー 必須 説明
access_token △(*1)
proc reissue を指定してください

(*1)〜X-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定。

コンテント

キー 必須 説明 データ型 備考
email メールアドレス String

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

HTTPステータス

ステータスコード 説明
204 正常終了
400 不正なリクエスト内容
401 トークン未指定。認証失敗
403 基本設定の「メールアドレスの利用」が「利用する」になっていない。またはアクセス権限がない
404 指定されたemailが見つからない
422 コンテント不適切
500 APIサーバエラー

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。

リクエストサンプル

レスポンスサンプル

例)Curlコマンド

関連ドキュメント

メールテンプレートを管理する

メールテンプレートを管理する

メールをカスタマイズする

アプリで会員を管理するとき、特定のタイミングで会員にメール送信される状況が発生します。
「基本設定」では、会員に送信されるメールの件名本文をカスタマイズすることができます。

以下にその手順について説明します。

メールテンプレートの設定を確認する

会員管理の「基本設定」ページの中段に「テンプレートをカスタマイズする」の項目があることを確認下さい。

panel_appuser_template_00_all_ja

項目のうち「種別」とあるラジオボタンで「メールテンプレート」を選択します。

panel_appuser_template_mail_00_type_ja

「種別」の直下にある「テンプレート」のプルダウンが、すべてメールテンプレートに置き換わり、
実際にカスタマイズしたいメールテンプレートを選択できるようになります。

panel_appuser_template_mail_01_spec_ja

カスタマイズ可能なメールテンプレートについて

会員に送信されるメールのうち、自由にカスタマイズできるテンプレートは5種類あります。

種類 説明
1 メールアドレス確定通知メール 会員登録時 (REST API「会員登録する」利用時) に、メールアドレスを検証するために送信されるメールです。
2 メールアドレス確定通知メール(更新時) 会員更新時 (REST API「会員を更新する」利用時) に、メールアドレスを確認するため送信されるメールです。
3 メールアドレス確定通知メール (メール会員登録用) 会員登録時に、メールアドレスを検証するために送信されるメールです。通常の会員登録と異なり最初にメールアドレスを登録するタイプ (REST API「メールアドレス確認通知を依頼する」利用時) の場合に使用されます。
4 パスワード再発行通知メール パスワード再発行を希望するユーザに送信されます。
5 アカウントロックメール 10回以上ログインに失敗した場合に送信されるアカウントロック通知・解除のメールです。

また、それぞれに対して日本語英語のテンプレートを設定できます。
日本語英語については「テンプレート」下部の「言語」のラジオボタンで切り替えていただくことができます。

panel_appuser_template_mail_02_lang_ja

それぞれのテンプレートには、アプリ名やログイン名など、テンプレートが実際に処理されるときに埋め込まれる動的な変数があります。
いずれも%%ではじまり、%%で終わる変数となります。
例えば %%APP_NAME%% は「アプリ名」を意味しますが、各テンプレートで利用できる変数はいずれも決まっています。

panel_appuser_template_02

メールテンプレートのカスタマイズ

以下、それぞれのメールの用途についての詳細と、そのカスタマイズについて説明します。

メールアドレス確認通知メール

(REST API「会員登録する」利用時)
会員としてアプリに登録するときに、基本設定でメールアドレスによる認証を必須としている場合に送信されるメールです。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。ただし題名ではつかえません。
%%URL%% は「メールアドレスを検証するためのリンク」です。ただし題名ではつかえません。これは必須です。

メールアドレス確認通知メール (更新時)

(REST API「会員を更新する」利用時)
登録されている会員情報を更新するときに、基本設定でメールアドレスによる認証を必須としている場合に送信されるメールです。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。ただし題名ではつかえません。
%%URL%% は「メールアドレスを検証するためのリンク」です。ただし題名ではつかえません。これは必須です。

メールアドレス確認通知メール (メールでの会員登録時)

(REST API 「メールアドレス確認通知を依頼する」利用時)
こちらもおなじようにメールアドレスによる認証を必須とする場合に送信されます。
ただし前項と異なり、会員登録の方法として先にログインIDを登録するのではなく、
メールアドレスの登録を事前におこなう方法が選択されている場合に送信されます。
当然ながら本文には%%LOGIN_ID%%を使うことはできません。

%%APP_NAME%% は「アプリ名」です。
%%URL%% は「メールアドレスを検証するためのリンク」です。ただし題名ではつかえません。これは必須です。

パスワード再発行通知メール

会員がパスワード再発行を希望するとき、その案内としてユーザに送信されるメールです。
記載されるURLをクリックすることでパスワード設定画面が表示されます。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。ただし題名ではつかえません。
%%URL%% は「メールアドレスを検証するためのリンク」です。ただし題名ではつかえません。これは必須です。

アカウントロックメール

ユーザが10回以上ログインに失敗した場合に送信される、アカウントロック通知・解除のためのメールです。
記載されるURLをクリックすることでアカウントロックが解除され、解除を通知する画面が表示されます。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。ただし題名ではつかえません。
%%URL%% は「メールアドレスを検証するためのリンク」です。ただし題名ではつかえません。これは必須です。

基本設定をする

基本設定をする

基本設定をする

設定を行うアプリの会員管理より “基本設定”をクリックし基本設定画面に移動します。

ログインID / パスワード認証を設定する

基本設定を表示させると、会員のログインIDパスワードによる認証の設定が可能です。「会員のログインID認証」で”設定する”を選択し、「保存」ボタンをクリックすると設定が完了します。

本設定で利用するを選択し、会員のログインID認証を有効化することで、REST API会員API / ログインする“で、ログインID / パスワードを用いたログインが有効になります。

image

メールアドレス認証を設定する

基本設定を表示させると、会員のメールアドレス(*1)とパスワードによる認証の設定が可能です。「会員のメールアドレス認証」で”設定する”を選択し、「保存」ボタンをクリックすると設定が完了します。

本設定で利用するを選択し、会員のメールアドレス認証を有効化することで、REST API会員API / ログインする“で、メールアドレス / パスワードを用いたログインが有効になります。

(*1)〜メールアドレス認証で利用可能なメールアドレスは確認済みのメールアドレスのみとなります。

image

メールアドレスの登録を設定する

基本設定を表示させると、会員のメールアドレスの登録を設定することが可能です。本設定を行うことで、以下の2つの機能が有効になります。

  1. REST API(*2)へのリクエストコンテントで、メールアドレス(キーがemail)を指定する際に指定したメールアドレスに対し、メールアドレスの確認通知が送信されます。
  2. REST API(*2)へのリクエストコンテントで、メールアドレス(キーがemail)の指定が可能となります。

(*2)~対象のREST APIは会員API / 会員を登録する会員API / メールアドレス確認通知を依頼する

image

匿名認証を設定する

基本設定を表示させると、 アプリ利用者が意識しない形での会員登録を許容する、匿名認証の設定が可能です。「 匿名認証」で 利用する を選択し、「保存」ボタンをクリックすると設定が完了します。

本設定で設定するを選択し、会員のメールアドレス認証を有効化することで、REST API会員API / 会員登録するで、UUID形式(RFC4122)(*3)を用いたログインが有効になります。

(*3)~UUIDの例 “bcd9d62c-caf5-443f-aa3a-c9cc109295d9″

image

会員削除方法を指定する

会員削除時の、”物理削除”、”論理削除” を設定を行います。

削除方法 説明 備考
物理削除 会員を削除すると、データベースから会員情報が完全に削除されます。
論理削除 会員を削除すると、会員情報を “削除した”という状態に変更します。 削除しても利用データ容量は削減されません。また、論理削除状態の会員情報は、コントロールパネル上より参照することができます。

「会員の削除方式」で「物理削除」または「論理削除」のいずれかを選択し、「保存」ボタンをクリックすると設定が完了します。

image

ストアトークンの継続利用を設定する

会員によるサービスへのログイン時、すでに別のブラウザやデバイスからのログインがあった場合、古いアクセストークン(「ストアトークン」)は破棄され、新しいアクセストークンが発行されます。
デフォルトでは 都度発行する が設定されており、新しい環境からログインするときに古いほうのログイン状態が無効化され、これによってサービスの不正利用を防ぐことが可能となります。
一方で複数のブラウザやデバイスからの同時ログインをユーザに許可したい場合、継続的に利用する に設定することで、別のブラウザやデバイスによるログイン状態が破棄されず、異なる環境からのログインでもユーザはサービスを継続的に利用することが可能となります。

image

会員の操作をする

会員の操作をする

会員管理

会員に対する操作(登録 / 更新 / 削除)は SDKやREST API以外に、コントロールパネル上からも行うことができます。

会員一覧を表示する

「会員管理」タブをクリックし、会員一覧画面を表示します。

# 項目名 説明
1 基本設定ボタン 基本設定画面に遷移します。
2 会員登録ボタン 会員登録画面に遷移します。
3 会員編集ボタン 会員編集画面に遷移します。
4 会員ID 会員を一意に識別するIDです。コントロールパネルから登録された会員には、システムから自動発番されたIDが割り当てられます。
5 ログインID 会員がログインする際に使用する認証用IDです。
6 メールアドレス 会員のメールアドレスです。メールアドレス認証を“設定する”に設定した場合のみ表示されます。
7 会員種別アイコン 会員種類を表すアイコンを表示します。
8 作成日時 会員が登録された日時を表示します。
9 登録日時 会員情報が更新された日時を表示します。
10 会員削除ボタン 会員削除を行う際にクリックします。
11 会員詳細ボタン 会員詳細画面に遷移します。

image

会員詳細を表示する

会員管理より 「会員詳細」ボタンをクリックし、会員詳細画面を表示します。

# 項目名 説明
1 会員ID 会員を一意に識別するIDです。コントロールパネルから登録された会員には、システムから自動発番されたIDが割り当てられます。
2 SNS連携 連携先のソーシャルネットワークのアイコンが表示されます。SNS連携機能を利用して登録された会員にのみ表示されます。
3 ログインID 会員がログインする際に使用する認証用IDです。
4 パスワード 会員がログインする際に使用する認証用パスワードです。
5 メールアドレス 会員のメールアドレスです。メールアドレス認証を“設定する”に設定した場合のみ表示されます。
6 登録日 会員が登録された日時を表示します。
7 更新日 会員情報が更新された日時を表示します。
8 会員データ JSON形式で自由に定義することができる会員属性情報です。
9 パスワード再設定ボタン パスワード再設定画面に遷移します。
10 戻るボタン 会員一覧画面に遷移します。
11 会員編集ボタン 会員編集画面に遷移します。
12 会員削除ボタン 会員削除を行う際にクリックします。

image

会員登録する

会員管理より 「会員登録」ボタンをクリックし、会員登録画面を表示します。

会員登録必要な情報 123(メールアドレス認証設定の場合表示されています。)と4会員属性情報(アプリの開発者が任意に設定できる項目)を入力して、 5の「登録確認」ボタンをクリックします。

# 項目名 説明
1 ログインID 認証用のログインID。
2 パスワード 認証用のパスワード。
3 メールアドレス メールアドレス。メールアドレス認証を”設定する”に設定した場合のみ表示されます。
4 会員データ 会員にひもづく属性情報。キーと値を自由に設定できます。

image

登録確認画面で、「登録」ボタンをクリックすると、会員管理(会員一覧)画面が表示され登録が完了します。

image

会員削除する

会員管理(会員一覧)で「会員を削除」ボタンをクリックし会員削除確認画面を表示します。

image

「削除」ボタンをクリックすると、会員削除が完了します。

会員情報を編集する

会員管理(会員一覧)より「会員編集」ボタンをクリックして、会員詳細変更画面を表示します。

JSON形式で表示されている会員属性情報 / メールアドレスを必要に応じて編集し、「変更確認」ボタンをクリックします。

確認画面で “確認”を選択することで、会員編集が完了します。

会員パスワードを再設定する

会員詳細画面で 「パスワード再設定」ボタンをクリックします。

パスワード再設定画面で、「新しいパスワード」「新しいパスワード(確認)」を入力し、「変更確認」ボタンをクリックします。

パスワード再設定確認画面で、「変更」ボタンをクリックすることで、パスワードの変更が完了します。

ページテンプレートを管理する

ページテンプレートを管理する

ページをカスタマイズする

アプリで会員を管理するとき、特定のタイミングで会員にウェブページが表示される状況が発生します。
基本設定では、会員に送信される本文をカスタマイズすることができます。

以下にその手順について説明します。

ページテンプレートの設定を確認する

会員管理の「基本設定」ページの中段に「テンプレートをカスタマイズする」の項目があることを確認下さい。

panel_appuser_template_00_all_ja

項目のうち「種別」とあるラジオボタンで「ページテンプレート」を選択します。

panel_appuser_template_page_00_type_ja

「種別」の直下にある「テンプレート」のプルダウンが、すべてページテンプレートに置き換わり、
実際にカスタマイズしたいページテンプレートを選択できるようになります。

panel_appuser_template_page_01_spec_ja

ページテンプレートのカスタマイズについて

会員に表示されるウェブページのうち、自由にカスタマイズできるテンプレートは12種類あります。

種類 説明
1 会員登録完了ページ 会員登録 (REST API「会員登録する」利用時) の完了時、メールアドレスの確認が完了した会員に対して表示されるページです。
2 会員更新完了ページ メールアドレスの確認が完了した会員 (REST API「会員更新する」利用時)に対して表示されるページです。
3 パスワード設定ページ (メールでの会員登録時) 会員登録 (REST API「メールアドレス確認通知を依頼する」利用時) のステップの一つとしてパスワードを設定するためのページです。
4 会員登録完了ページ (メールでの会員登録時) 会員登録 (REST API「メールアドレス確認通知を依頼する」利用時) の完了時、メールアドレスの確認が完了した会員に対して表示されるページです。
5 アカウントロック解除完了ページ アカウントロックが解除された会員に対して表示されるページです。
6 パスワード再設定ページ 会員がパスワードを再設定するためのページです。
7 パスワード再設定完了ページ パスワード再設定が完了した会員に対して表示されるページです。
8 メールによるログインページページ メールアドレスでログインするためのページです。
9 ログインIDによるログインページ ログインIDでログインするためのページです。
10 ログイン完了ページ ログインが完了したときに表示されるページです。
11 ログアウト完了ページ ログアウトが完了したときに表示されるページです。
12 エラーページ エラーが発生した場合に表示されるページです。

また、それぞれに対して日本語英語のテンプレートを設定できます。
日本語英語については「テンプレート」下部の「言語」のラジオボタンで切り替えていただくことができます。

panel_appuser_template_page_02_lang_ja

それぞれのテンプレートには、アプリ名やログイン名など、テンプレートが実際に処理されるときに埋め込まれる動的な変数があります。
いずれも%%ではじまり、%%で終わる変数となります。
例えば %%APP_NAME%% は「アプリ名」を意味しますが、各テンプレートで利用できる変数はいずれも決まっています。

panel_appuser_template_02

ページテンプレートのカスタマイズ

以下、それぞれのウェブページの用途についての詳細と、そのカスタマイズについて説明します。

会員登録完了ページ

(REST API 「会員登録する」利用時)
会員としてアプリに登録するとき、メールアドレスによる認証が完了したユーザに対して表示されるページです。
「メールアドレス確定通知メール」に記載されたURLをクリックしたあとに表示されるページです。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。

会員更新完了ページ

(REST API 「会員登録する」利用時)
すでに登録されている会員の情報を更新するとき、メールアドレスによる認証が完了したユーザに対して表示されるページです。
「メールアドレス確定通知メール」に記載されたURLをクリックしたあとに表示されるページです。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。

パスワード設定ページ (メールでの会員登録時)

(REST API 「メールアドレス確認通知を依頼する」利用時)
会員登録の方法としてログインIDを先に登録するのではなく、メールアドレスの登録を
事前におこなう方法が選択されている場合、ユーザはパスワードを設定する必要があります。
これはパスワードを設定するために表示されるページです。

%%EMAIL%% は会員の「メールアドレス」です。これは必須です。
%%ERROR_MESSAGES%% は入力エラー時に表示される「エラーメッセージ」です。これは必須です。

会員登録完了ページ (メールでの会員登録時)

(REST API 「メールアドレス確認通知を依頼する」利用時)
「会員登録完了ページ」と同じく、メールアドレスの確定が完了した会員に対して表示されるページです。
「メールアドレス確認通知メール (メールでの会員登録時)」に記載されたURLをクリックしたあとに表示されます。
「会員登録完了ページ」との違いとして、ログインIDを先に登録するのではなく、最初にメールアドレスを登録するタイプの場合に使用されます。
当然ながらページ内容には%%LOGIN_ID%%を使うことはできません。

%%APP_NAME%% は「アプリ名」です。

アカウントロック解除完了ページ

アカウントロックが解除された会員に対して表示されるページです。
「アカウントロックメール」に記載されたURLをクリックしたあとに表示されます。

%%APP_NAME%% は「アプリ名」です。
%%LOGIN_ID%% は会員の「ログインID」です。

パスワード再設定ページ

会員登録 (REST API「メールアドレス確認通知を依頼する」利用時)のステップの一つとしてパスワードを設定するためのページです。

%%ERROR_MESSAGES%% は入力エラー時に表示される「エラーメッセージ」です。これは必須です。

パスワード再発行完了ページ

前項の「パスワード再設定ページ」でパスワードを設定したあと、パスワード再設定が完了した会員に対して表示されるページです。

%%APP_NAME%% は「アプリ名」です。

メールによるログインページ

メールアドレスでログインするためのページです。

%%ERROR_MESSAGES%% は入力エラー時に表示される「エラーメッセージ」です。これは必須です。

ログインIDによるログインページ

ログインIDでログインするためのページです。

%%ERROR_MESSAGES%% は入力エラー時に表示される「エラーメッセージ」です。これは必須です。

ログイン完了ページ

ログインが完了したときに表示されるページです。

ログアウト完了ページ

ログアウトが完了したときに表示されるページです。

エラーページ

システムエラーが発生した場合に会員に表示されるページです。
埋め込むことのできる変数はありません。

ログインフォーム(HTML)を表示する

会員登録済みのログインID または メールアドレスと、パスワードの組み合わせでのログインフォーム(HTML)を表示します。

基本仕様

予めコントロールパネルより登録済みの下記2つのログインフォーム(HTML)を表示します。

  • ログインIDによるログインページ
  • メールによるログインページ

表示されたログインフォームに、正しいログインID または メールアドレスと、パスワードの組み合わせを入力することで、ログインする(*1)ことが可能です。

(*1)〜ストアトークンの取得が可能となり、REST APIの ログインすると同等の処理が実行されます。

HTTPメソッド

GET

エンドポイント

/v1/t/{データストアID}/{アプリID}/m/loginForm

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN アプリトークンを指定ください。

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

ヘッダ

キー名 説明
Content-Type text/html; charset=UTF-8

HTTPステータス

ステータスコード 説明
200 ログインフォーム表示成功

コンテント

ログインフォーム(HTML)が返却されます。

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の 共通エラーレスポンスを参照。

メールアドレス確認通知を依頼する

メールアドレスを登録します。

基本仕様

アピアリーズの会員管理を利用して、メールアドレスを登録します。

本REST API(メールアドレスを登録する)はコントロールパネルの会員管理 / 基本設定にて、メールアドレスの登録設定するで設定の場合に有効化されます。また、本REST APIへリクエスト実施後にメールアドレス確認の通知が送信され、メールアドレス確認の通知本文に記載されているURLをクリックし表示される画面にてパスワードを登録後、メールアドレス / パスワードでのログインが可能となります。(*1)

(*1)〜コントロールパネル / 基本設定にて、 会員のメールアドレス認証設定するで指定されている場合。

HTTPメソッド

POST

エンドポイント

/v1/usr/{データストアID}/{アプリID}/_new/requestEmail

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*2) アプリトークンを指定ください。
Content-Type application/json

クエリ

キー 必須 説明
access_token △(*2)

(*2)〜X-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定。

コンテント

キー 必須 説明 データ型 備考
email メールアドレス String (*3)

(*3)〜コントロールパネル、基本設定で メールアドレスの登録許可するに設定の場合、キー( email)の受付が許可されます。また、そのタイミングで、メールアドレス確認通知が送信されます。

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

ヘッダ

キー名 説明 備考
Content-Type application/json

HTTPステータス

ステータスコード 説明
202 メールアドレス確認通知の依頼が受け付けられました。

コンテント

無し。

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。

リクエストサンプル

SNS連携

Facebook連携機能を有効化する

Facebook Developers サイトでの作業

Facebookと連携したアプリを開発する場合、予め連携するアプリの情報を Facebook Developers サイトで登録する必要があります。
アプリ登録手順等は本ドキュメントでは割愛していますので、詳細については Facebook Developers サイトを確認ください。
尚、コントロールパネルからSNS連携機能を有効にする際に、App IDApp Secret が必要となりますので、
Facebook Developers でのアプリ登録時に忘れず控えておいてください。

fb-figure-1.png

Facebook連携設定

Facebookと連携するにあたり、コントロールパネル側で設定を行う必要があります。

  1. 会員管理基本設定画面を開きます。

  2. Facebook連携設定セクションの各フィールドに、Facebookと連携するために必要な情報を入力します。
    各フィールドの入力値については下表を参考ください。

    項目 説明
    Facebook連携を有効にする ONの状態にすることで連携機能が有効になります。
    App ID Facebook Developers で登録したアプリのApp IDを指定します。
    App Secret Facebook Developers で登録したアプリのApp Secretを指定します。

fb-figure-2.png

  1. 保存ボタンをクリックし設定編集を完了します。

Twitter連携機能を有効化する

TwitterのConsumer Keyを取得する。

Twitterと連携したアプリを開発する場合、予め連携するアプリの情報を Twitter Apps サイトで登録する必要があります。 アプリ登録手順等は本ドキュメントでは割愛していますので、詳細については Twitter Apps サイトを確認ください。
尚、コントロールパネルからSNS連携機能を有効にする際に、Consumer Key が必要となりますので、Twitter Apps でのアプリ登録時に忘れず控えておいてください。

tw-figure-1.png

Twitter連携設定

Twitterと連携するにあたり、コントロールパネル側で設定を行う必要があります。

  1. 会員管理基本設定画面を開きます。

  2. Twitter連携設定セクションの各フィールドに、Facebookと連携するために必要な情報を入力します。
    各フィールドの入力値については下表を参考ください。

    項目 説明
    Twitter連携を有効にする ONの状態にすることで連携機能が有効になります。
    Consumer Key Twitter Apps で登録したアプリのConsumer Keyを指定します。

    tw-figure-2.png

  3. 保存ボタンをクリックし設定編集を完了します。

関連

SNS連携

機能と特色

SNS連携は、FacebookやTwtiterといったソーシャルネットワーキングサービスのアカウントとアピアリーズの会員を連携させる機能です。

Facebook/Twitterアカウントを用いた会員登録 / ログイン

SNS連携は、SNSのアカウント (Facebook / Twitter)を利用した会員(アピアリーズを利用して管理する会員)登録、ログイン機能を提供します。会員登録、ログイン必須の会員制アプリなどでは、ログインにかかるストレスを低減させることが期待できます。
さらに、Facebook Graph API や Twitter API といった、サービスベンダーが提供するAPIと容易に連携させることができるため、アイディア次第でSNSと連動させた魅力的なアプリを開発することができるでしょう。

関連ドキュメント