設定 - C# SDK

C#アプリケーションの作成を開始する前に、まずZohoでアプリを認証する必要があります。そのためには、いくつかの設定手順を実行する必要があります。基本的に、OAuthクライアントの詳細はapp.configファイル内のセクションとして指定する必要があります。

注：

  • app.configファイルは、.Net Coreアプリケーションのみにあります。
  • ASP.NET、ASP Webアプリ、ASP Webサイトなどの場合は、設定ディクショナリーを使用してアプリケーションを設定してください。

app.configファイルにセクションoauth_configurationを追加し、そのセクションの属性タイプが「ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK」であることを確認してください。次に例を示します。

<configuration>
<configSections>
<section name="oauth_configuration" type="ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK"></section>
<section name="zcrm_configuration" type="ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK"></section>
</configSections>
<oauth_configuration>
<settings>
<add key = "client_id" value = "" />
<add key = "client_secret" value = "" />
<add key = "redirect_uri" value = "" />
<add key = "access_type" value = "" />
<add key = "iamUrl" value = "" />
<add key = "persistence_handler_class" value = ""/>
<add key = "mysql_username" value = "" />
<add key = "mysql_password" value = "" />
<add key = "mysql_database" value = "" />
<add key = "mysql_server" value = "" />
<add key = "mysql_port" value = "" />
<add key = "oauth_tokens_file_path" value = "" />
</settings>
</oauth_configuration>
<zcrm_configuration>
<settings>
<add key = "apiBaseUrl" value = ""/>
<add key = "photoUrl" value = ""/>
<add key = "apiVersion" value = ""/>
<add key = "logFilePath" value = ""/>
<add key = "timeout" value = ""/>
<add key = "minLogLevel" value = "'"/>
<add key = "currentUserEmail" value = "" />
<add key = "domainSuffix" value = "" />
</settings>
</zcrm_configuration>
</configuration>
  • client_id、client_secret、redirect_uriは、Zohoクライアントの登録後に取得するOAuthクライアントの設定です。
  • access_typeはデフォルトでオフラインに設定されます。アクセストークンとリフレッシュトークンは、オフラインのときにのみ受信されます。
  • iamUrl - OAuthアカウントの呼び出し時に使用するURL。ユーザーのドメインを示すために使用されます。URLは次のとおりです。
    • アメリカ https://accounts.zoho.com
    • ヨーロッパ諸国 https://accounts.zoho.eu
    • 中国 https://accounts.zoho.com.cn
  • persistence_handler_classは、IZohoPersistenceHandlerインターフェイスの実装です。これには、OAuthデータを格納するためのハンドラーメソッドがあります。これについては、次のセクションで説明します。
    例：persistence_handler_class=ZCRMSDK.OAuth.ClientApp.ZohoOAuthFilePersistence, ZCRMSDK（または）ZCRMSDK.OAuth.ClientApp.ZohoOAuthDBPersistence, ZCRMSDK（または）独自の永続化ハンドラークラス。
  • DB永続性（ZohoOAuthDBPersistence.cs）を使用する場合は、mysql接続用にmysql_usernameキーとmysql_passwordキーを指定する必要があります。
    • デフォルトは、mysql_username = "root"、mysql_password = ""、mysql_database = "zohooauth"、mysql_server = "localhost"、mysql_port = "3306"です。
    • 認証プロセスが完了すると、トークンが作成され、データベーステーブルに自動的に配置されます（ZohoOauthDBPersistenceセクションで説明されています）。
  • SDKのファイルの永続性を永続化ハンドラーとして使用する場合は、oauth_tokens_file_pathが必要です。ユーザーのトークンを保存するためのファイルのパスです。

上記のOAuth構成以外に、SDKには特定のHTTPリクエスト属性を上書きするオプションもあります。これらの構成は、app.configファイルのzcrm_configurationという名前のセクションで指定する必要があります。

セクションのタイプは、「ZCRMSDK.CRM.Library.Common.ConfigFileHandler.ConfigFileSection, ZCRMSDK」にする必要があります。

zcrm_configurationセクションでは、次の構成がサポートされています。

  • apiBaseUrl - APIの呼び出し時に使用するURL。ユーザーのドメインを示すために使用されます。URLは次のとおりです。
    • https://www.zohoapis.com
    • https://www.zohoapis.eu
    • https://www.zohoapis.com.cn
  • photoUrl - データを表すイメージのURL。ドメインは、apiBaseUrlに基づいて異なる場合があります。URLは次のとおりです。
    • https://profile.zoho.com/api/v1/user/self/photo
    • https://profile.zoho.eu/api/v1/user/self/photo
    • https://profile.zoho.com.cn/api/v1/user/self/photo
  • apiVersionは「V2」です。
  • timeOut - リクエストのタイムアウトをミリ秒単位で表します。省略するか、不要な場合は空にしてください。
  • minLogLevel - SDKのログ記録の最小ログレベルを表します。サポートされている値は、ALL、INFO、WARNING、ERROR、OFFです。デフォルトの最小ログレベルはWARNINGです。
  • logFilePath - SDKがログに記録できるファイルを表します。オプションの構成であり、省略可能です。省略した場合、SDKはアプリケーションの実行ディレクトリー内の動作をファイル（LogFile.log）の下に記録します。ログを保存するには、ファイル名を除いたファイルのパスのみが必要です。
  • currentUserEmail - 単一ユーザーの場合、この設定を設定できます。
  • domainSuffix - オプションの設定。複数DCサポートを提供します。例：com、euまたはcn。

注：

  • 「logFilePath」のファイルパスが指定されていない場合、プロジェクトの「{Project}/bin/Debug/netcoreapp2.1/」フォルダーに「logFile.log」が作成されます。