A powerful PHP library for the Bitrix24 REST API
CI\CD status on master |
|---|
 |
 |
 |
Integration tests run in GitHub actions with real Bitrix24 portal
Support both auth modes:
- work with auth tokens for Bitrix24 applications in marketplace
- work with incoming webhooks for simple integration projects for current portal
Domain core events:
- Access Token expired
- Bitrix24 portal domain url changed
API - level features
- Auto renew access tokens
- List queries with «start=-1» support
- offline queues
Performance improvements 🚀
- Batch queries implemented with PHP Generators – constant low memory and
low CPI usage
- batch read data from bitrix24
- batch write data to bitrix24
- write and read in one batch package
- composite batch queries to many entities (work in progress)
- read without count flag
Low-level tools to devs:
- Rate-limit strategy
- Retry strategy for safe methods
- Good developer experience
- auto-completion of methods at the IDE
- typed method call signatures
- typed results of method calls
- helpers for typical operations
- Good documentation
- documentation on the operation of a specific method containing a link to the official documentation
- documentation for working with the SDK
- Performance first:
- minimal impact on client code
- ability to work with large amounts of data with constant memory consumption
- efficient operation of the API using batch requests
- Modern technology stack
- based on Symfony HttpClient
- actual PHP versions language features
- Reliable:
- test coverage: unit, integration, contract
- typical examples typical for different modes of operation and they are optimized for memory \ performance
- http2 protocol via json data structures
- symfony http client
- \Bitrix24\SDK\Core\ApiClient - work with b24 rest-api endpoints
input: arrays \ strings
output: Symfony\Contracts\HttpClient\ResponseInterface, operate with strings
process: network operations
- \Bitrix24\SDK\Services\* - work with b24 rest-api entities
input: arrays \ strings
output: b24 response dto
process: b24 entities, operate with immutable objects
Help bitrix24-php-sdk by boosty.to/bitrix24-php-sdk
- php: >=8.2
- ext-json: *
- ext-curl: *
Add "mesilov/bitrix24-php-sdk": "2.x" to composer.json of your application. Or clone repo to your project.
declare(strict_types=1);
use Bitrix24\SDK\Services\ServiceBuilderFactory;
use Monolog\Logger;
use Symfony\Component\EventDispatcher\EventDispatcher;
require_once 'vendor/autoload.php';
$webhookUrl = 'INSERT_HERE_YOUR_WEBHOOK_URL';
$log = new Logger('bitrix24-php-sdk');
$b24ServiceFactory = new ServiceBuilderFactory(new EventDispatcher(), $log);
// init bitrix24-php-sdk service
$b24Service = $b24ServiceFactory->initFromWebhook($webhookUrl);
// work with interested scope
var_dump($b24Service->getMainScope()->main()->getCurrentUserProfile()->getUserProfile());
var_dump($b24Service->getCRMScope()->lead()->list([],[],['ID','TITLE'])->getLeads()[0]->TITLE);Tests locate in folder tests and we have two test types.
In folder tests create file .env.local and fill environment variables from .env.
Fast, in-memory tests without a network I\O For run unit tests you must call in command line
composer phpunit-run-unit-testSlow tests with full lifecycle with your test Bitrix24 portal via webhook.
❗️Do not run integration tests with production portals
For run integration test you must:
- Create new Bitrix24 portal for development tests
- Go to left menu, click «Sitemap»
- Find menu item «Developer resources»
- Click on menu item «Other»
- Click on menu item «Inbound webhook»
- Assign all permisions with webhook and click «save» button
- Create file
/tests/.env.localwith same settings, see comments in/tests/.envfile.
APP_ENV=dev
BITRIX24_WEBHOOK=https:// your portal webhook url
INTEGRATION_TEST_LOG_LEVEL=500- call in command line
composer composer phpunit-run-integration-testsCall in command line
composer phpstan-analyseBugs and feature request are tracked on GitHub
bitrix24-php-sdk is licensed under the MIT License - see the MIT-LICENSE.txt file for details
Maksim Mesilov - [email protected]
See also the list of contributors which participated in this project.
[email protected] for private consultations or dedicated support
Bitrix24 API documentation - Russian
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent