Download the PHP package mesilov/bitrix24-php-sdk without Composer
On this page you can find all versions of the php package mesilov/bitrix24-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package bitrix24-php-sdk
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 ✨FEATURES✨
Support both auth modes:
- [x] work with auth tokens for Bitrix24 applications in marketplace
- [x] work with incoming webhooks for simple integration projects for current portal
Domain core events:
- [x] Access Token expired
- [x] Bitrix24 portal domain url changed
API - level features
- [x] Auto renew access tokens
- [x] List queries with «start=-1» support
- [ ] offline queues
Performance improvements 🚀
- Batch queries implemented with PHP Generators – constant low memory and
low CPI usage
- [x] batch read data from bitrix24
- [x] 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
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
Sponsors
Help bitrix24-php-sdk by boosty.to/bitrix24-php-sdk
Requirements
- php: >=8.2
- ext-json: *
- ext-curl: *
Installation
Add "mesilov/bitrix24-php-sdk": "2.x" to composer.json of your application. Or clone repo to your project.
Examples
Work with webhook
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.
Unit tests
Fast, in-memory tests without a network I\O For run unit tests you must call in command line
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:
- 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. - call in command line
PHP Static Analysis Tool – phpstan
Call in command line
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
Authors
Maksim Mesilov - [email protected]
See also the list of contributors which participated in this project.
Need custom Bitrix24 application?
[email protected] for private consultations or dedicated support
Documentation
Bitrix24 API documentation - Russian
All versions of bitrix24-php-sdk with dependencies
ext-json Version *
ext-bcmath Version *
ext-curl Version *
ext-intl Version *
psr/log Version ^2 || ^3
fig/http-message-util Version 1.1.*
ramsey/uuid Version ^3 ||^4
moneyphp/money Version ^3 || ^4
symfony/http-client Version ^6 || ^7
symfony/http-client-contracts Version ^2 || ^3
symfony/http-foundation Version ^6 || ^7
symfony/event-dispatcher Version ^6 || ^7
symfony/uid Version ^6 || ^7