配置
开始创建 php 应用程序之前,需要先向 Zoho 认证应用。为此,需要完成一些配置过程。验证应用程序共有两种方法:
- 传递配置数组 - 然后调用 ZCRMRestClient::initialize($configuration);
- 数组选项仅适用于 1.1.0 及以上版本。
- 使用资源文件夹中的属性文件 - 然后调用 ZCRMRestClient::initialize();
属性文件
您的 OAuth 客户端明细将作为属性文件提供给 PHP SDK。在 PHP SDK 中,我们已放置配置文件 (oauth_configuration.properties)。请在该文件中设置相应值。可在“vendor/zohocrm/php-sdk/src/resources”下找到该文件。
仅填写以下键。根据您的域(EU 或 CN),更改 accounts_url 的值。默认值设置为 US 域。
client_secret=
redirect_uri=
accounts_url=https://accounts.zoho.com
token_persistence_path=
- 只会填写以上显示的键。
- client_id、client_secret 和 redirect_uri 是注册 Zoho 客户端后获取的 OAuth 客户端配置。
- access_type 必须设置为 offline 的唯一原因是 PHP SDK 目前不支持在线 OAuth 客户端。
- persistence_handler_class 是 ZohoOAuthPersistenceInterface 的实现,即 ZohoOAuthPersistenceHandler。
- token_persistence_path 是文件形式的 OAuth 相关令牌。如果设置了此项,那么不需要数据库来进行保存。保存仅通过文件进行。
在客户端应用的机器上创建名为“ZCRMClientLibrary.log”的文件,并在 configuration.properties 中对键“applicationLogFilePath”指定所创建文件的绝对路径。可在“vendor/zohocrm/php-sdk/src/resources”下找到该文件。该文件将记录使用 PHP SDK 期间发生的异常。
仅填写以下键
要对 sandobx 帐户进行 API 调用,请在 configurations.properties 文件中将以下键的值更改为 true。默认情况下,此值为 false。
如果您的应用程序只需要单用户认证,那么您必须在 configurations.properties 文件中按以下方式设置用户电子邮件 ID。
要使用多用户认证,您需要在 PHP 超级全局变量“$_SERVER”中按以下方式设置用户电子邮件 ID:
也可对单用户认证使用 $_SERVER 变量,但建议通过在 configuration.properties 文件中设置电子邮件 ID 进行。
如果未将用户电子邮件设置为超级全局变量,那么 SDK 要求它包含在 configuration.properties 文件中。如果未使用以上任何方式设置用户电子邮件,那么 PHP SDK 将抛出异常。
配置数组
现在,当您调用 ZCRMRestclient::initialize() 函数时,可以将配置值作为 php 数组(键值对)参数来传递。下面是数组中的键列表。
必需键 | 可选键 |
---|---|
client_id | applicationLogFilePath |
client_secret | sandbox |
redirect_uri | apiBaseUrl |
currentUserEmail | apiVersion |
client_secret | access_type |
accounts_url | |
persistence_handler_class | |
token_persistence_path |
注:
- 如果并非全局存在,则必须指定键“currentUserEmail”。
- 如果未指定可选键,则会自动分配其默认值。
- 如果用户不在“com”域,则‘apiBaseUrl’和‘accounts_url’是必需的。
下面是包含必备键的 PHP 数组示例。
下面是包含所有键的 PHP 数组示例。