README

@bitrix/crest — 一个用于在本地、批量应用程序或通过Webhook使用Bitrix24 REST API的PHP SDK

内容

1. 描述
2. 使用入站Webhook调用
3. 从本地应用程序调用
4. 从批量应用程序调用

描述

• 示例使用cURL模块执行REST请求。了解如何在您的服务器上启用cURL模块。
• 您的Web服务器必须安装有效的SSL证书。
• 示例使用CRest类作为基本SDK执行请求和续订令牌。从存储库中下载文件，进行必要的修改（与授权相关的修改）到settings.php文件，并将其放置在您的服务器上，插入文档中的所需示例。
• 如果SDK出现问题时，您可以通过浏览器打开checkserver.php文件，它将对CRest类的工作进行最小设置检查。
• 如果项目中使用CRest类且编码不是utf8，则需要进行以下两项额外操作
  
  解压缩文件并更改它们的编码到所需编码。
  在settings.php文件中声明C_REST_CURRENT_ENCODING常数。例如，如果项目使用windows-1251编码，常数应如下所示

define('C_REST_CURRENT_ENCODING','windows-1251');

使用入站Webhook调用REST

在settings.php文件中的C_REST_WEB_HOOK_URL中指定Webhook URL

define('C_REST_WEB_HOOK_URL','https://xxx.bitrix24.ru/rest/1/douasdqdsxSWgc3mgc1/');

将示例文本插入index.php文件

require_once('src/crest.php');

// put an example below
echo '<PRE>';
print_r(CRest::call(
   'crm.lead.add',
   [
      'fields' =>[
      'TITLE' => 'Название лида',//Заголовок*[string]
      'NAME' => 'Имя',//Имя[string]
      'LAST_NAME' => 'Фамилия',//Фамилия[string]
      ]
   ])
);

echo '</PRE>';

将示例URL指定为浏览器地址栏 https://mydomain.xxx/index.php，以查看示例的运行结果。

从本地应用程序调用REST

将示例文本插入index.php文件

require_once('src/crest.php');

// put an example below
echo '<PRE>';
print_r(CRest::call(
   'crm.lead.add',
   [
      'fields' =>[
      'TITLE' => 'Название лида',//Заголовок*[string]
      'NAME' => 'Имя',//Имя[string]
      'LAST_NAME' => 'Фамилия',//Фамилия[string]
      ]
   ])
);

echo '</PRE>';

在本地应用程序卡片中指定您的应用程序URL https://mydomain.xxx/index.php 和安装脚本URL https://mydomain.xxx/install.php。在settings.php文件中的C_REST_CLIENT_ID和C_REST_CLIENT_SECRET中指定用于OAuth 2.0授权的client_id和client_secret参数值，从本地应用程序卡片中获取这些值。

require_once('src/crest.php');

// put an example below
echo '<PRE>';
print_r(CRest::call(
   'crm.lead.add',
   [
      'fields' =>[
      'TITLE' => 'Название лида',//Заголовок*[string]
      'NAME' => 'Имя',//Имя[string]
      'LAST_NAME' => 'Фамилия',//Фамилия[string]
      ]
   ])
);

echo '</PRE>';

在本地应用程序列表中，右键单击您的本地应用程序并选择“重新安装”。这是在您插入正确的C_REST_CLIENT_ID和C_REST_CLIENT_SECRET值后，确保install.php正确工作所必需的。安装后，您将看到示例的运行结果。如果示例演示了将小部件嵌入其他Bitrix24工具，则需要转到这些工具。

从批量应用程序调用REST

将示例文本插入index.php文件

require_once('src/crest.php');

// put an example below
echo '<PRE>';
print_r(CRest::call(
   'crm.lead.add',
   [
      'fields' =>[
      'TITLE' => 'Название лида',//Заголовок*[string]
      'NAME' => 'Имя',//Имя[string]
      'LAST_NAME' => 'Фамилия',//Фамилия[string]
      ]
   ])
);

echo '</PRE>';

在合作伙伴控制台中添加批量应用程序以获取client_id和client_secret，并在保存应用程序时。在settings.php文件中的C_REST_CLIENT_ID和C_REST_CLIENT_SECRET中指定用于OAuth 2.0授权的client_id和client_secret参数值。

require_once('src/crest.php');

// put an example below
echo '<PRE>';
print_r(CRest::call(
   'crm.lead.add',
   [
      'fields' =>[
      'TITLE' => 'Название лида',//Заголовок*[string]
      'NAME' => 'Имя',//Имя[string]
      'LAST_NAME' => 'Фамилия',//Фамилия[string]
      ]
   ])
);

echo '</PRE>';

在应用程序卡片中添加版本，并指定您的应用程序URL https://mydomain.xxx/index.php 和安装脚本URL https://mydomain.xxx/install.php 到版本卡片中。保存版本后，打开版本卡片，点击“在自己的Bitrix24上安装”链接，将您的应用程序安装在任何可用的Bitrix24上。安装后，您将看到示例的运行结果（如果示例演示了将小部件嵌入其他Bitrix24工具，则必须转到这些工具）。对于实际的批量应用程序，需要继承CRest类，重定义getSettingData/setSettingData方法，这些方法负责获取/保存令牌授权到文本文件。这些方法不适用于在多个Bitrix24上同时运行应用程序。

crest