APIアクセス実装方法

Yahoo! ID連携ではウェブAPIアクセスにおいてOAuth2.0 Bearer Token Usageをサポートしています。任意のHTTPメソッドにおいてAuthorizationヘッダーにAccess Tokenを含めて送信することで、必要なウェブAPIにアクセスできるようになります。

※Yahoo! ID連携がサポートするのはAuthorizationヘッダーによるAccess Tokenの送信のみであり、URLクエリパラメーターやリクエストボディでのAccess Tokenの送信には対応しておりません。

リクエスト

POST /path/to/webEndPoint?param=var HTTP/1.1
Host: xxxxxx.yahooapis.jp
Authorization: Bearer [access_token]

サンプルリクエスト

POST /yconnect/v2/attribute HTTP/1.1
Host: userinfo.yahooapis.jp
Authorization: Bearer SlAV32hkKG

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

エラー詳細については WWW-Authenticate ヘッダー内の error_description を確認してください。（WWW-Authenticate ヘッダーが付与されない場合もあります）

HTTP
ステータス WWW-Authenticate
ヘッダー内のパラメータ説明クライアント側のエラーハンドリング方法

400

HTTP ステータス	WWW-Authenticate ヘッダー内のパラメータ	説明	クライアント側のエラーハンドリング方法
400	`error="invalid_request"`	Access Tokenがヘッダとリクエストパラメータの両方に含まれており競合しています。	クライアント側の実装方法が正しいか見直してください。
401	`なし` または `error="invalid_token"`	Access Access Tokenが不正、有効期限切れ、または無効です。	リクエストにAccess Tokenを正しく付与しているか確認してください。 Access Tokenが有効期限切れまたは無効の場合は、Refresh Tokenを使用してAccess Tokenを更新するか、新たにAccess Tokenを取得してください。
403	`なし`	ユーザーにアクセス認可されていません。スコープ外のWeb APIへのアクセスです。	アプリケーションで利用可能なスコープおよびscopeパラメーターに不足がないかご確認ください。

error="invalid_request"

Access Tokenがヘッダとリクエストパラメータの両方に含まれており競合しています。

クライアント側の実装方法が正しいか見直してください。

401

なし

または

error="invalid_token"

Access Access Tokenが不正、有効期限切れ、または無効です。

リクエストにAccess Tokenを正しく付与しているか確認してください。
Access Tokenが有効期限切れまたは無効の場合は、Refresh Tokenを使用してAccess Tokenを更新するか、新たにAccess Tokenを取得してください。

403

なし

ユーザーにアクセス認可されていません。スコープ外のWeb APIへのアクセスです。

アプリケーションで利用可能なスコープおよびscopeパラメーターに不足がないかご確認ください。

ウェブAPI固有のレスポンスについてはウェブAPIの仕様書を参照してください。