Bitrix24 REST API PHP SDK

An official PHP library for the Bitrix24 REST API

SDK Versions

This library ships two major versions that coexist on separate branches:

Which version should I use?

• v1 — choose this for PHP 8.2–8.4 projects, production deployments, or when you don't need the newest Bitrix24 API methods.
• v3 — choose this for PHP 8.4+ projects that need access to new REST API methods and are comfortable adopting breaking changes.

Build status

CI\CD check	main	v3
allowed licenses
php-cs-fixer
phpstan
rector
deptrac	—
unit tests

Integration tests run in GitHub actions with real Bitrix24 portal

Installation

Install the stable v1 version (PHP 8.2+):

composer require bitrix24/b24phpsdk:"^1.0"

Install the new v3 version (PHP 8.4+, breaking changes):

composer require bitrix24/b24phpsdk:"^3.2"

If you work on Windows:

• please use WSL - Windows Subsystem for Linux
• if your filesystem is NTFS, you can disable the flag git config --global core.protectNTFS false for checkout folders starting with a dot.

Branch status

Each major version has its own dev branch. Cross-version changes are applied via cherry-pick — branches are never merged across major versions.

B24PhpSdk ✨FEATURES✨

Support both auth modes:

• work with auth tokens for mass-market Bitrix24 applications
• work with incoming webhooks for simple integration projects for a single Bitrix24 account

Domain core events:

• Access Token expired
• Url of a Bitrix24 account domain 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
• read without count flag

Development principles

• 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

Architecture

Abstraction layers

- 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  

Documentation

• Bitrix24 API documentation - English

Requirements

• php: >=8.2
• ext-json: *
• ext-curl: *

Examples

Work with webhook

1. Go to /examples/webhook folder
2. Open console and install dependencies

composer install

3. Open Bitrix24 account: Developer resources → Other → Inbound webhook
4. Open example file and insert webhook url into $webhookUrl

declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

require_once 'vendor/autoload.php';

// init bitrix24-php-sdk service from webhook
$b24Service = ServiceBuilderFactory::createServiceBuilderFromWebhook('INSERT_HERE_YOUR_WEBHOOK_URL');

// call some method
var_dump($b24Service->getMainScope()->main()->getApplicationInfo()->applicationInfo());
// call core for method in not implemented service
var_dump($b24Service->core->call('user.current'));

5. Call php file in shell

php -f example.php

Work with local application

1. Go to /examples/local-app folder
2. Open console and install dependencies

composer install

3. Start local development server

sudo php -S 127.0.0.1:80

4. Expose local server to public via ngrok and remember temporally public url – https://****.ngrok-free.app

ngrok http 127.0.0.1

5. Check public url from ngrok and see x-powered-by header with 200 status-code.

curl https://****.ngrok-free.app -I
HTTP/2 200 
content-type: text/html; charset=UTF-8
date: Mon, 26 Aug 2024 19:09:24 GMT
host: ****.ngrok-free.app
x-powered-by: PHP/8.3.8

6. Open Bitrix24 account: Developer resources → Other → Local application and create new local application:
   • type: server
   • handler path: https://****.ngrok-free.app/index.php
   • Initial installation path: https://****.ngrok-free.app/install.php
   • Menu item text: Test local app
   • scope: crm
7. Save application parameters in index.php file:
   • Application ID (client_id) — BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID
   • Application key (client_secret) — BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET
   • Assing permitions (scope) — BITRIX24_PHP_SDK_APPLICATION_SCOPE

declare(strict_types=1);

use Bitrix24\SDK\Core\Credentials\ApplicationProfile;
use Bitrix24\SDK\Services\ServiceBuilderFactory;
use Symfony\Component\HttpFoundation\Request;

require_once 'vendor/autoload.php';
?>
    <pre>
    Application is worked, auth tokens from bitrix24:
    <?= print_r($_REQUEST, true) ?>
</pre>
<?php

$appProfile = ApplicationProfile::initFromArray([
    'BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID' => 'INSERT_HERE_YOUR_DATA',
    'BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET' => 'INSERT_HERE_YOUR_DATA',
    'BITRIX24_PHP_SDK_APPLICATION_SCOPE' => 'INSERT_HERE_YOUR_DATA'
]);

$b24Service = ServiceBuilderFactory::createServiceBuilderFromPlacementRequest(Request::createFromGlobals(), $appProfile);

var_dump($b24Service->getMainScope()->main()->getCurrentUserProfile()->getUserProfile());

Create application for Bitrix24 marketplace

if you want to create application you can use production-ready contracts in namespace Bitrix24\SDK\Application\Contracts:

• Bitrix24Accounts — Store auth tokens and provides methods for work with Bitrix24 account.
• ApplicationInstallations — Store information about application installation, linked with Bitrix24 Account with auth tokens. Optional can store links to:
  • Client contact person: client person who responsible for application usage
  • Bitrix24 Partner contact person: partner contact person who supports client and configure application
  • Bitrix24 Partner: partner who supports client portal
• ContactPersons – Store information about person who installed application.
• Bitrix24Partners – Store information about Bitrix24 Partner who supports client portal and install or configure application.

Steps:

1. Create own entity of this bounded contexts.
2. Implement all methods in contract interfaces.
3. Test own implementation behavior with contract-tests tests/Unit/Application/Contracts/* – examples.

Tests

Tests locate in folder tests and we have two test types. In folder tests create file .env.local and fill environment variables from .env.

PHP Static Analysis Tool – phpstan

Call in command line

make lint-phpstan

PHP Static Analysis Tool – rector

Call in command line for validate

make lint-rector

Call in command line for fix codebase

make lint-rector-fix

Unit tests

Fast, in-memory tests without a network I\O For run unit tests you must call in command line

make test-unit

Integration tests

Slow tests with full lifecycle with your test Bitrix24 account via webhook.

❗️Do not run integration tests with production Bitrix24 accounts

For running integration test you must:

1. Create new Bitrix24 account for development tests.
2. Go to left menu, click «Sitemap».
3. Find menu item «Developer resources».
4. Click on menu item «Other».
5. Click on menu item «Inbound webhook».
6. Assign all permisions with webhook and click «save» button.
7. Create file /tests/.env.local with same settings, see comments in /tests/.env file.

BITRIX24_WEBHOOK=https://your-portal.bitrix24.com/rest/1/your-webhook-token/
INTEGRATION_TEST_LOG_LEVEL=100

8. call in command line

make test-integration-core
make test-integration-scope-telephony
make test-integration-scope-workflows
make test-integration-scope-user

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

Thanks to all the people who contributed so far!

License

B24PhpSdk is licensed under the MIT License - see the MIT-LICENSE.txt file for details