初期化 - PHP SDK

OAuth構成ファイルを定義した後に、アプリを初期化する準備が整います。

自己承認の認可トークンとリフレッシュトークンの作成

自己クライアントアプリの場合、Zoho Developer Console(https://accounts.zoho.com/developerconsole)から自己承認認可トークンを作成する必要があります。

  1. https://accounts.zoho.com/developerconsoleにアクセスします。
  2. 権限を付与するクライアントの[オプション][自己クライアント]をクリックしてください。
  3. 承認する有効なZoho CRMスコープを(複数の場合はカンマで区切って)[スコープ]項目に入力し、有効期限を選択してください。Zoho CRMスコープと共に「aaaserver.profile.READ」スコープを提供します。
  4. バックアップ用の認可トークンをコピーします。
  5. 以下のURLでPOSTリクエストを行うことによって、認可トークンからrefresh_tokenを作成します。
    https://accounts.zoho.com/oauth/v2/token?code={grant_token}&redirect_uri={redirect_uri}&client_id={client_id}&client_secret={client_secret}&grant_type=authorization_code
  6. バックアップ用のリフレッシュトークンをコピーします。

作成された認可トークンは、作成時に選択した規定時間のみ有効です。したがって、その時間内にアクセストークンとリフレッシュトークンを作成する必要があります。

アクセストークンの作成

アクセストークンは、認可トークンまたはリフレッシュトークンによって作成できます。2つの方法のいずれかに従うだけで十分です。

認可トークンからのアクセストークンの作成

アクセストークンとリフレッシュトークンを取得するには、メインクラスから次のコードスニペットを実行する必要があります。コピーされた認可トークンを、以下の文字列リテラルに貼り付けてください。これは1回限りのプロセスです。

ZCRMRestClient::initialize();
$oAuthClient = ZohoOAuth::getClientInstance();
$grantToken = “paste_the_self_authorized_grant_token_here”;
$oAuthTokens = $oAuthClient->generateAccessToken($grantToken);
 

上記のコードスニペットは、認可トークンごとに1回だけ有効です。上記のコードスニペットが正常に実行されると、作成されたアクセストークンとリフレッシュトークンは、永続化ハンドラークラスによって永続化されます。

リフレッシュトークンからのアクセストークンの作成

アクセストークンとリフレッシュトークンを取得するには、メインクラスから次のコードスニペットを実行する必要があります。作成されたリフレッシュトークンを、以下の指定された文字列リテラルに貼り付けてください。これは1回限りのプロセスです。

ZCRMRestClient::initialize();
$oAuthClient = ZohoOAuth::getClientInstance();
$refreshToken = "paste_the_refresh_token_here";
$userIdentifier = "provide_user_identifier_like_email_here";
$oAuthTokens = $oAuthClient->generateAccessTokenFromRefreshToken($refreshToken,$userIdentifier);
 

上記のコードスニペットが正常に実行されると、作成されたアクセストークンと指定されたリフレッシュトークンは、永続化ハンドラークラスによって永続化されます。

OAuthトークンが保存されると、以降のAPI呼び出しでは保存されたアクセストークンとリフレッシュトークンが使用されます。PHP SDKは、必要に応じて、リフレッシュトークンを使用してアクセストークンをリフレッシュします。

アプリの起動

PHP SDKでは、クライアントアプリを起動するたびに、次のコード行を呼び出す必要があります。

ZCRMRestClient::initialize();
 

PHP SDKが上記の行で初期化されたら、SDKの任意のAPIを使用して適切な結果を得ることができます。