OAuth設定 - Java SDK

Javaアプリケーションの作成を開始する前に、まずZohoでアプリケーションを認証する必要があります。そのためには、いくつかの設定手順を実行する必要があります。基本的には、OAuth情報とZCRM設定情報を提供するために、2つの異なるプロパティーファイルをSDKに設定する必要があります。

oauth_configuration.properties

必要なクライアントID、シークレット、アクセスタイプなどの情報が含まれるOAuth設定ファイル。これらはすべて、Zohoでアプリを登録するときに使用できます。また、ファイルに必要な追加情報もいくつかあります。ファイルは以下の形式で、次のプロパティーとそれぞれの値を持つ必要があります。

client_id=
client_secret=
redirect_uri=
scope=
access_type=
persistence_handler_class=
mysql_username=root
mysql_password=
proxyHost=192.168.100.100
proxyPort=3128
proxyUserDomain=ZOHOCORP
proxyUser=larry-4404
oauth_tokens_file_path=

  • client_idclient_secretredirect_uriは、Zohoクライアントの登録後に取得するOAuthクライアントの設定です。
  • scopeは有効なZoho CRMスコープです(複数の場合はカンマで区切ってください)。必要な他のスコープと共に、Aaaserver.profile.Readスコープを追加してください。これは必須です。
  • access_typeは、オフラインまたはオンラインに設定できます。
  • persistence_handler_classは、ZohoPersistenceHandlerインターフェイスの実装です。これには、OAuthデータを格納するためのハンドラーメソッドがあります。これについては、次のセクションで説明します。
    たとえば、persistence_handler_class=com.zoho.oauth.clientapp.ZohoOAuthFilePersistence(または)com.zoho.oauth.clientapp.ZohoOAuthDBPersistence(または)独自の永続化ハンドラークラス。
  • DB永続性(ZohoOAuthDBPersistence.java)を使用する場合は、mysql接続用にmysql_usernameキーとmysql_passwordキーを指定する必要があります。
    • デフォルトでは、mysql_username = rootとmysql_password =です。
    • 認証プロセスが完了すると、トークンが作成され、データベーステーブルに自動的に配置されます(ZohoOauthDBPersistenceセクションで説明されています)。
  • MySQLパスワードを持っているか、またはoauth_configurations.propertiesファイルでプロキシーを設定する必要があります。
  • ファイルの永続性を使用している場合、oauth_tokens_file_pathは、アクセストークン、リフレッシュトークンなどを含むプロパティーファイル"oauthtokens.properties"への相対パスです。このファイルには次のプロパティーを含める必要があります。

useridentifier=
accesstoken=
refreshtoken=
expirytime=

プロジェクトに追加する必要があるプロパティーファイルがもう1つあります。これについては、次のセクションで説明してください。