Yahoo! ID連携

APIアクセス実装方法

ウェブAPIのアクセス方法

Yahoo! ID連携ではウェブAPIアクセスにおいてOAuth2.0 Bearer Token Usageをサポートしており、以下3とおりの方法によりAccess Tokenを送信できます。

Access TokenをHTTPヘッダーに含む形で送信するので、GET/POST/PUTなど任意のHTTPメソッドでもリクエストが送信でき、Access TokenとウェブAPI固有のパラメータ分離できるのが特徴です。特別な理由がないかぎりAuthorizationヘッダーを使ったウェブAPIリクエスト方式を推奨します。

GET /path/to/webEndPoint?param=var HTTP/1.1
Host: xxxxxx.yahooapis.jp
Authorization: Bearer ‹access_token›

GET /yconnect/v2/attribute?access_token=SlAV32hkKG HTTP/1.1
Host: userinfo.yahooapis.jp

クライアントアプリがウェブブラウザー（Javascript）で動作する場合など、HTTPヘッダーにAccess Tokenを含めて送信するのが難しい場合に適したウェブAPIリクエスト方式です。

POST /path/to/webEndPoint HTTP/1.1
Host: xxxxx.yahooapis.jp
Content-Type: application/x-www-form-urlencoded

param=var&access_token=‹access_token›

GET /yconnect/v2/attribute?access_token=SlAV32hkKG HTTP/1.1
Host: userinfo.yahooapis.jp

クライアントアプリがウェブブラウザー（Javascript）で動作する場合など、HTTPヘッダーにAccess Tokenを含めて送信するのが難しい場合に適したウェブAPIリクエスト方式です。

GET /path/to/webEndPoint?access_token=‹access_token›&param=var
Host: xxxxx.yahooapis.jp

GET /yconnect/v2/attribute?access_token=SlAV32hkKG HTTP/1.1
Host: userinfo.yahooapis.jp

ユーザー認証に関連するエラーレスポンスはWWW-Authenticateヘッダーで返却されます。

HTTPステータス	WWW-Authenticateヘッダー内のパラメータ	説明	クライアント側のエラーハンドリング方法
400	error="invalid_request"	Access Tokenが空である、不正なフォーマットである、もしくは重複しています。	クライアント側の実装方法が正しいか見直してください。
401	error="invalid_token"	Access TokenAccess Tokenが有効期限切れ、もしくはその他の理由で無効になっています。	クライアント側でRefresh Tokenを保持している場合は、動的にAccess Token更新を行ってください。
402	error="insufficient_scope"	ユーザーにアクセス認可されていません。スコープ外のWeb APIへのアクセスです。	アプリケーションで利用可能なスコープおよびscopeパラメーターに不足がないかご確認ください。