Bitrix24 PHP SDK 使用教程

Bitrix24 PHP SDK 使用教程

1. 项目的目录结构及介绍

Bitrix24 PHP SDK 项目的目录结构如下：

bitrix24-php-sdk/
├── docs/
│   └── EN/
├── examples/
│   └── webhook/
├── src/
│   └── Bitrix24/
│       └── SDK/
│           └── Services/
├── tests/
│   └── Unit/
│       └── Application/
│           └── Contracts/
├── tools/
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── MIT-LICENSE.txt
├── Makefile
├── README.md
├── SECURITY.md
├── composer.json
├── phpstan.neon.dist
├── phpunit.xml.dist
└── rector.php

目录介绍

• docs/: 包含项目的文档，目前只有英文文档。
• examples/: 包含示例代码，特别是 webhook 示例。
• src/: 项目的源代码，主要逻辑都在这里。
• tests/: 包含项目的测试代码，特别是单元测试。
• tools/: 包含一些工具脚本。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• MIT-LICENSE.txt: 项目许可证。
• Makefile: 用于构建和测试的 Makefile。
• README.md: 项目主文档。
• SECURITY.md: 安全政策文档。
• composer.json: Composer 依赖管理文件。
• phpstan.neon.dist: PHPStan 静态分析工具配置。
• phpunit.xml.dist: PHPUnit 测试工具配置。
• rector.php: Rector 代码重构工具配置。

2. 项目的启动文件介绍

项目的启动文件主要是 examples/webhook/example.php，这是一个示例文件，展示了如何使用 Webhook 与 Bitrix24 API 进行交互。

启动文件介绍

declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// 插入你的 Webhook URL
$webhookUrl = 'https://your-portal-webhook-url';

// 初始化服务构建器
$serviceBuilder = ServiceBuilderFactory::create($webhookUrl);

// 使用服务构建器进行 API 调用
// 例如：$serviceBuilder->getTelephonyService()->callMethod();

使用步骤

1. 打开 examples/webhook/example.php 文件。
2. 将 $webhookUrl 替换为你的 Bitrix24 门户的 Webhook URL。
3. 运行示例文件，进行 API 调用。

3. 项目的配置文件介绍

项目的配置文件主要包括 composer.json 和 Makefile。

composer.json

composer.json 文件定义了项目的依赖和其他配置信息。

{
    "require": {
        "mesilov/bitrix24-php-sdk": "2.x"
    }
}

Makefile

Makefile 文件定义了一些常用的命令，用于构建和测试项目。

test-integration-core:
    # 运行核心集成测试

test-integration-scope-telephony:
    # 运行电话集成测试

test-integration-scope-workflows:
    # 运行工作流集成测试

test-integration-scope-user:
    # 运行用户集成测试

使用步骤

1. 在项目根目录下运行 composer install 安装依赖。
2. 使用 make 命令运行集成测试，例如 make test-integration-core。

以上是 Bitrix24 PHP SDK 项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！