f1yback/lazy-bitrix

简单封装以提升Bitrix24 API的使用体验

1.0.1 2022-10-03 10:40 UTC

This package is auto-updated.

Last update: 2024-09-30 01:52:13 UTC


README

简单封装以提升Bitrix24 API的使用体验

安装

使用composer require命令

composer require f1yback/lazy-bitrix

使用

指定配置数组 $credentials 中所需的密钥和请求客户端。在应用上下文中:domainauth;当使用webhook时:domainwebhookid

应用上下文配置

$credentials = [
    'domain' => 'mycompany.bitrix24.com',
    'auth' => 'some_auth_key', 
]; 

Webhook配置

$credentials = [
    'domain' => 'mycompany.bitrix24.com',
    'webhook' => '8hgvhbcr19elk576', // webhook key
    'id' => '283', // webhook creator id
]; 

$credentials 准备就绪时 - 直接将其传递给构造函数

使用 request 方法调用Bitrix24 API。方法接受3个参数:method - Bitrix24方法名称(例如 'crm.lead.list'),callback - 可调用函数以处理来自Bitrix24的 $response,以及 data - 应该是包含Bitrix24 API方法输入参数的 array|null

use f1yback\Bitrix24\LazyBitrix;

$api = new LazyBitrix($credentials);

// use method without $data
$api->request('crm.lead.list', function($response){
    // handle $response from Bitrix24 whatever you want
    ... your code
});

// use method with $data
$api->request('crm.deal.get', function($response){
    // handle $response from Bitrix24 whatever you want
    ... your code
}, ['id' => 187203]);

有关Bitrix24 API中可用方法的更多信息,请 - 阅读文档