README

这是一个用于 Bitrix24 REST API 的基本 PHP 库。该库包含身份验证模块。

Bitrix24 文档

俄语文档
英文文档

要求

• php: >=7.0.0
• ext-json: *
• ext-curl: *
• ext-mysqli: *

示例

<?php
use Bitrix24API\Bitrix24;

$Bitrix24 = new Bitrix24(
    array(
        'companyDomain' => 'example.bitrix24.com', //Bitrix24 company URL
        'scope' => 'crm,user,telephony', //Bitrix24 auth scopes. Available variants: https://training.bitrix24.com/rest_help/rest_sum/premissions_scope.php

        //Auth data
        'auth' => array(
            //Bitrix24 User auth data
            'login'    => 'user@bitrix24.com',
            'password' => '1234',

            //Bitrix24 App auth data
            'clientId' => 'local.55a6ca262e8482.12345678',
            'clientSecret' => 'eOk9XtOWbdTjUgQmBL1MYNpKl0Jwt11JLHYHIADX62f3c6PA29'
        ),

        //Database config
        'database' => array(
            'settingsTableName' => 'config',
            'settingsKeyName' => 'key',
            'settingsValueName' => 'value'
        )
    ),
    array(
        '127.0.0.1', //MySQL Host
        'user',	//MySQL Username
        '1234',	//MySQL Password
        'db', //MySQL Database
        3306 //MySQL Port
    ) //Database connection
);

//Gets deal with DEAL_ID = '1234'
$dealData = $Bitrix24->callMethod("crm.deal.get", array('id'=>'1234'));

settingsKeyName 和 settingsValueName 的值是什么？

PHP Bitrix24 API Module 使用标准键值对表来存储数据。以下是一个示例
如果您为键值对有不同的名称（例如：选项 作为键 - 配置 作为值），您需要在配置中指定这些名称。否则库将无法正常工作。

安装

1. 将库安装到您的项目中：composer require oihso/bitrix24-api-module
2. 创建新的表（或使用现有的表）来存储设置。该表必须是键值类型。键和值必须是 TEXT 字段
3. 向表中添加“php_bitrix24_auth_time” = “0”行
4. 向表中添加“php_bitrix24_auth_code” = “code”行

如何配置您的 Bitrix24

1. 转到 应用程序 -> 添加应用程序 -> 仅我的账户 -> 添加 并创建带有 仅 API 复选框的应用程序。您还需要选择所有必需的作用域
2. 复制 client_id 和 client_secret 并将其粘贴到 Bitrix24 类配置中
3. 在左侧菜单中转到 邀请用户 并注册新用户。它将是您的 REST API 的“服务”帐户
4. 为您的新“服务”帐户创建新的 组/部门
5. 为此 组/部门 设置权限。您需要为此帐户允许管理规则。
6. 现在，您可以将用户凭据粘贴到 Bitrix24 类配置中

许可证

"PHP Bitrix24 API Module" 根据 Apache 许可证许可 - 详细信息请参阅 LICENSE.txt 文件