YSAPI_AUTH (Y!Connect認証クラス)

  1. new：コンストラクタ

  2. Authorization：Y!Connect認証処理を実行します

  3. GetToken：アクセストークンを取得

  4. GetRefreshToken：リフレッシュトークンを利用してアクセストークンを取得

  5. YSAPI_TOKEN_INFO：アクセストークン情報モデル

__construct($client_id="",$secret="")

認証クラスの新規インスタンスを作成します。$auth = new YSAPI_AUTH('client_id','secret');

IN/OUT   説明 必須 備考
in $client_id Yahoo!デベロッパーネットワークで登録したアプリケーションID ※  
$secret Yahoo!デベロッパーネットワークで登録したアプリケーションのシークレット △ アプリケーションをサーバーサイドで登録した場合のみ必須
out YSAPI_AUTH Y!Connect 認証オブジェクト    

Authorization()

Y!Connect認証処理を実行してアクセストークンを取得します。
初回は自動でYahoo!ログインページへリダイレクトされます。
認証後はセッション変数にアクセストークン・リフレッシュトークン・有効期限を保持して、有効期限内は保持しているアクセストークンを返却、期限切れの場合はリフレッシュトークンを利用してアクセストークンを再取得して返却します。
リフレッシュトークンの有効期限が切れた場合は、再度Yahoo!ログインページへリダイレクトされます。$access_token = $auth->Authorization();

IN/OUT   説明 必須 備考
out access_token アクセストークン   各ＡＰＩファンクションの実行時に必要になります

GetToken()

Authorizationエンドポイントより取得した認可コードを元にアクセストークンを取得します。$access_token = $auth->GetToken();

IN/OUT   説明 必須 備考
in $_REQUEST['code'] 認可コード ※ Authorization()を実行する事により、ログイン画面よりリダイレクト時に付加されます
out access_token アクセストークン   各ＡＰＩファンクションの実行時に必要になります

GetRefreshToken()

リフレッシュトークンを利用してアクセストークンを取得します。$access_token = $auth->GetRefreshToken();

IN/OUT   説明 必須 備考
out access_token アクセストークン   各ＡＰＩファンクションの実行時に必要になります

YSAPI_TOKEN_INFO

アクセストークン情報モデル

プロパティ名 内容 TYPE 備考
access_token アクセストークン string Access Token。APIへアクセスするのに使用します。最大1024Byte の可変長トークンです。
token_type アクセストークンタイプ string Web APIへアクセスする際にAccess Tokenを適切に用いるために必要な情報を提供します。
Bearer Token形式です。
expires_in アクセストークン有効時間 int Access Tokenの有効期限を表す秒数です。
limit アクセストークン有効期限 dateTime Access Token取得日時にexpires_inを加算した日時
refresh_token リフレッシュトークン string Refresh Token。Access Tokenを更新するときに使用します。有効期限は4週間です。最大512Byteの可変長文字列です。

2017/07/25