Bitrix24 REST API PHP SDK

A powerful PHP library for the Bitrix24 REST API

Build status

CI\CD status on master

Integration tests run in GitHub actions with real Bitrix24 portal

BITRIX24-PHP-SDK Documentation

• Russian
• English

BITRIX24-PHP-SDK ✨FEATURES✨

Support both auth modes:

• work with auth tokens for Bitrix24 applications in marketplace
• work with incoming webhooks for simple integration projects for current portal

Low-level tools to devs:

• Domain core events:
  • Access Token expired
  • Bitrix24 portal domain url changed
• Rate-limit strategy
• Retry strategy for safe methods

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

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 butch 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

- http protocol
- json data
- 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\Main - work with b24 rest-api entities
    input: arrays \ strings (?) or queries?
    output: b24 response dto
    process: b24 entities, operate with  

File Structure

    /Core
        ApiClient.php - default api-client, work on http abstraction layer, return - Symfony\Contracts\HttpClient\ResponseInterface
    /Services
        /CRM
            /Deals
                /Client
                    Deals.php
                /Exceptions
        /Tasks
        … 
        Main.php - default bitrix24 rest api service provide basic funcions, work with data transfer objects

Requirements

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

Example

Installation

Add "mesilov/bitrix24-php-sdk": "2.x" to composer.json of your application. Or clone repo to your project.

Tests

Tests locate in folder tests and we have two test types

Unit tests

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

composer phpunit-run-unit-test

Integration tests

Slow 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:

1. Create new Bitrix24 portal 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.

APP_ENV=dev
BITRIX24_WEBHOOK=https:// your portal webhook url
INTEGRATION_TEST_LOG_LEVEL=500

8. call in command line

composer composer phpunit-run-integration-tests

PHP Static Analysis Tool – phpstan

Call in command line

 composer phpstan-analyse

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

License

bitrix24-php-sdk is licensed under the MIT License - see the MIT-LICENSE.txt file for details

Author

Maxim Mesilov - [email protected] - https://twitter.com/mesilov
See also the list of contributors which participated in this project.

Need custom Bitrix24 application?

email: [email protected]

Sponsors

Documentation

Bitrix24 API documentation - Russian

Bitrix24 API documentation - English

Register new Bitrix24 account

Русский

Принципы по которым ведётся разработка

• хороший DX (Developer Experience)
  • автодополнение методов на уровне IDE
  • типизированные сигнатуры вызова методов
  • типизированные результаты вызова методов – используются нативные типы: int, array, bool, string
  • хелперы для типовых операций
• хорошая документация
  • документация по работе конкретного метода содержащая ссылку на офф документацию
  • документация по работе с SDK
• производительность:
  • минимальное влияние на клиентский код
  • возможность работать с большими объёмами данных с константным потреблением памяти
  • эффективная работа c API с использованием батч-запросов
• современный стек технологий:
  • библиотеки для работы с сетью и возможностью асинхронной работы
  • фичи новых версий PHP
• надёжной:
  • покрытие тестами: unit, интеграционные, контрактные
  • есть типовые примеры характерные для разных режимов работы и они оптимизированы по памяти \ быстродействию

Ключевые особенности

Слои SDK

Service – API-интерфейс для работы с конкретной сущностью

Зона ответственности:

• контракт на API-методы сущности

Входящие данные:

• сигнатура вызова конкретного API-метода

Возвращаемый результат:

• Core\Response (????) к обсуждению

В зависимости от метода может быть разный возвращаемый результат:

• результат выполнения операции типа bool
• идентификатор созданной сущности типа int
• сущность + пользовательские поля с префиксами UF_ типа array
• массив сущностей типа array
• пустой массив как результат пустого фильтра.

Если возвращать Core\Response, то в клиентском коде будут проблемы:

• длинные цепочки в клиентском коде для получения возвращаемого результата

// добавили сделку в Б24
$dealId = $dealsService->add($newDeal)->getResponseData()->getResult()->getResultData()[0];
// получили массив сделок
$deals = $dealsService->list([], [], [], 0)->getResponseData()->getResult()->getResultData();

• отсутствие релевантной вызываемому методу типизации возвращаемого результата.

Ожидание:

 add(array $newDeal):int // идентификатор новой сделки
 list(array $order, array $filter, array $select, int $start):array //массив сделок + постраничка
 get(int $dealId):array // конкретная сделка

Текущая реализация — возвращается унифицированный результат:

add(array $newDeal):Core\Response
list(array $order, array $filter, array $select, int $start):Core\Response

Core – вызов произвольных API-методов

Зона ответственности:

• вызов произвольных API-методов
• обработка ошибок уровня API
• запрос нового токена и повторение запроса, если получили ошибку expired_token

Входящие данные:

• string $apiMethod – название api-метода
• array $parameters = [] – аргументы метода

Возвращаемый результат: Core\Response – унифицированный объект-обёртка, содержит:

• Symfony\Contracts\HttpClient\ResponseInterface — объект ответа от сервера, может быть асинхронным
• Core\Commands\Command — информация о команде\аргументах которая была исполнена, используется при разборе пакетных запросов.

Для получения результата запроса к API используется метод Response::getResponseData, который декодирует тело ответа вызвав метод Symfony\Contracts\HttpClient::toArray Возвращается стандартизированный DTO ResponseData от API-сервера с полями:

• Result - DTO c результатом исполнения запроса;
• Time — DTO c таймингом прохождения запроса через сервера Битрикс24;
• Pagination — DTO постраничной навигации с полями next и total;

В случае обнаружения ошибок уровня домена будет выброшено соответствующее типизированное исключение.

Объект Result содержит метод getResultData, который возвращает массив с результатом исполнения API-запроса. В зависимости от вызванного метода там может быть:

• результат выполнения операции типа bool
• идентификатор созданной сущности типа int
• сущность + пользовательские поля с префиксами UF_ типа array
• массив сущностей типа array
• пустой массив как результат пустого фильтра.

ApiClient — работа с сетью и эндпоинтами API-серверов

Зона ответственности:

• передача данных по сети
• соблюдение контракта на эндпоинты с которыми идёт работы
• «подпись» запросов токенами \ передача их в нужные входящие адреса если используется авторизация по вебхукам

Используется: Symfony HttpClient

Входящие данные:

• тип http-запроса
• массив с параметрами

Возвращаемые результаты: — Symfony\Contracts\HttpClient\ResponseInterface

Формат передачи данных по сети

JSON по HTTP/2 или HTTP/1.1

Спонсоры