設定 - PHP SDK

phpアプリケーションの作成を開始する前に、まずZohoでアプリを認証する必要があります。そのためには、いくつかの設定手順を実行する必要があります。アプリケーションを認証するには、次の2つの方法があります。

  • 設定配列を渡します - ZCRMRestClient::initialize($configuration);を呼び出します。
    • 配列オプションは、バージョン1.1.0以降でのみ使用できます。
  • resourcesフォルダー内のプロパティーファイルを使用して、ZCRMRestClient::initialize();を呼び出します。

プロパティーファイル

OAuthクライアントの詳細は、PHP SDKにプロパティーファイルとして指定する必要があります。PHP SDKでは、設定ファイル（oauth_configuration.properties）を使用します。そのファイルにそれぞれの値を入力してください。このファイルは、「vendor/zohocrm/php-sdk/src/resources」の下にあります。

次のキーのみを入力してください。ドメイン（EU、CN）に基づいて、「accounts_url」の値を変更してください。デフォルト値はUSドメインとして設定されています。

client_id=
client_secret=
redirect_uri=
accounts_url=https://accounts.zoho.com
token_persistence_path=
 
  • 上に表示されているキーのみを入力してください。
  • client_id、client_secret、redirect_uriは、Zohoクライアントの登録後に取得するOAuthクライアントの設定です。
  • オンラインOAuthクライアントは現時点ではPHP SDKでサポートされていないため、access_typeはofflineのみに設定する必要があります。
  • persistence_handler_classは、ZohoOAuthPersistenceInterface、つまり、ZohoOAuthPersistenceHandlerを実装したものです。
  • token_persistence_pathは、OAuth関連のトークンをファイルに保存するパスです。上記が設定されている場合、永続化のためのデータベースは不要になります。永続化は、ファイルのみを介して行われます。

クライアントアプリマシンに「ZCRMClientLibrary.log」という名前のファイルを作成し、キー「applicationLogFilePath」のconfiguration.propertiesで作成したファイルの絶対パスを指定します。このファイルは、「vendor/zohocrm/php-sdk/src/resources」の下にあります。このファイルには、PHP SDKの使用中に発生した例外が記録されます。

次のキーのみを入力してください。

applicationLogFilePath=
 

SandboxアカウントへのAPI呼び出しを行うには、configurations.propertiesファイルで、次のキーの値をtrueに変更してください。デフォルトでは、値はfalseです。

sandbox=true
 

アプリケーションで単一ユーザー認証のみが必要な場合は、次のようにconfigurations.propertiesファイルでユーザーのメールアドレスを設定する必要があります。

currentUserEmail=user@email.com
 

複数ユーザー認証を使用するには、以下のようにPHPスーパーグローバル変数「$_SERVER」にユーザーのEmailIdを設定する必要があります。

$_SERVER[‘user_email_id’]=“user@email.com”
 

単一ユーザー認証にも$_SERVER変数を使用できますが、configuration.propertiesファイルでメールIDを設定することをお勧めします。

スーパーグローバル変数としてユーザーのメールを設定しない場合、SDKはconfiguration.propertiesファイルからのメールを想定します。これら2つのどちらにもユーザーのメールが設定されていない場合、PHP SDKは例外をスローします。

設定配列

ZCRMRestclient::initialize()関数を呼び出すときに、引数として設定値を、php配列（キー値とペア）として渡せるようになりました。以下に、配列に含まれるキーのリストを示します。

必須キーオプションキー
client_idapplicationLogFilePath
client_secretsandbox
redirect_uriapiBaseUrl
currentUserEmailapiVersion
client_secretaccess_type
 accounts_url
 persistence_handler_class
 token_persistence_path

注：

  • グローバルに存在しない場合、キー「currentUserEmail」を指定する必要があります（既存の機能）。
  • オプションキーが指定されていない場合、それらのデフォルト値が自動的に割り当てられます。
  • ユーザーが「com」ドメインに存在しない場合、「apiBaseUrl」と「accounts_url」は必須です。

以下に、必須キーを含むPHP配列の例を示します。

$configuration = array("client_id"=>"value","client_secret"=>"value","redirect_uri"=>"value","currentUserEmail"=>"value");
 

以下に、すべてのキーを含むPHP配列の例を示します。

$configuration=array("client_id"=>"value","client_secret"=>"value","redirect_uri"=>"value","currentUserEmail"=>"value","applicationLogFilePath"=>"value", "sandbox"=>"value","apiBaseUrl"=>"value","apiVersion"=>"value",access_type"=>"value","accounts_url"=>"value","persistence_handler_class"=>"value","token_persistence_path"=>"value");