概要
Web API はソーシャルPLUS でのソーシャルログインの結果から、ユーザ情報を利用したり、企業側で発行した会員ID を紐付けるなどのあらゆる処理に利用します。
ご利用には 機能導入サーバ側の要件 を満たす必要があります。
Schema
Web API は特に指定がない限り HTTP の GET メソッドでの提供となります。また、エンドポイントは以下のアドレスの下に定義されます。
https://api.socialplus.jp/api/{Resources}
すべての API アクセスには必ず SSL 通信を用いてください。
リクエスト、レスポンスには文字コード UTF-8 の JSON 形式を用います。
API キー
「API キー」は、ソーシャルログインマネージャー でサービス選択後、サイドメニューの[設定]>[API キー]のページから取得できます。
Web API で操作する対象のサービスを識別するため、必ず「API キー」の指定が必要です。
https://api.socialplus.jp/api/{Resources}?key={API キー}
GET /api/appinfo?key=54d7503feb24aca8796c49b7517... HTTP/1.1
Host: example.com
Content-Type: application/json; charset=utf-8
「API キー」があれば 個人情報へのアクセスが可能 になります。
API キーが外部に流出しないよう、管理には充分気をつけてください。API キーをクライアントサイドから利用するような実装(ブラウザ上の JavaScript、スマートフォンアプリのコードなど)でご利用にならないでください。
API キーが流出した場合は、ソーシャルログインマネージャーから破棄・再発行が可能です。
共通のデータ定義
ユーザの特定
特定のユーザについて操作する場合は「ソーシャルPLUS ID」、または事前に紐付けた「お客様サービス側ユーザID」での指定が必要です。
ログインしたユーザの「ソーシャルPLUS ID」または紐付け済みの「お客様サービス側ユーザID」を取得するには 認証対象のソーシャルPLUS IDの取得 (authenticated_user) API を利用します。
「お客様サービス側ユーザID」の紐付けには お客様サービス側ユーザID の紐付け (map) API を利用します。
「ソーシャルPLUS ID」および「お客様サービス側ユーザID」は、各 Web API で以下のパラメータとして指定されます。これらが指定可能な API では、有効な値の一方 を指定します(特に指定がない限り、両方を指定する必要はありません)。
パラメータ名 | ユーザの特定方法 |
---|---|
identifier | ソーシャルPLUS ID |
primary_key | お客様サービス側ユーザID(紐付け済みの場合に利用可能) |
ログインプロバイダ
ログインプロバイダを表す文字列は以下のとおりです。
ログインプロバイダ | パラメータや応答値に利用する文字列 |
---|---|
LINE | line |
Yahoo! JAPAN | yahoo |
facebook | |
新 Google | gplus |
旧 Google1 | google |
Apple | apple |
twitter | |
楽天2 | rakuten |
パラメータに指定する場合には ASCII 英小文字のみを利用します。
二値型
真か偽の二値を扱うリクエストの引数では、以下の文字列が "真" として扱われます。
true
yes
y
enabled
これらの文字列以外を指定した場合、または値を指定しない場合は "偽" として扱われます。
Timestamp
タイムスタンプは RFC 3339 (ISO 8601) 形式で扱います。
YYYY-MM-DDTHH:MM:SSZ