Weave Code
B24Phpsdk Laravel Package
bitrix24/b24phpsdk
Official PHP library for the Bitrix24 REST API, with two branches: v1 (stable, PHP 8.2–8.4) and v3 (active development, PHP 8.4+, new REST methods, breaking changes). Handles authentication, API calls, and batch requests.
Bitrix24 PHP SDK for REST API
Frequently asked questions about B24Phpsdk
- How do I install bitrix24/b24phpsdk in a Laravel application?
- Install it with Composer by running composer require bitrix24/b24phpsdk. The package is a plain PHP SDK, so Laravel does not need a special installer. After installing, bind the SDK services into Laravel's container through a service provider and centralize credentials in config/bitrix24.php or .env.
- Does bitrix24/b24phpsdk support Laravel 10, 11, or 12?
- The SDK is not tied to a specific Laravel version, but v1 requires PHP 8.2 to 8.4 and v3 requires PHP 8.4 or newer. Any modern Laravel release running on those PHP versions can use it. There are no Laravel-native queue jobs, Eloquent models, or Scout integration included, so you build those on top.
- Should I use v1 or v3 of the Bitrix24 PHP SDK?
- Choose v1 for PHP 8.2 to 8.4 production applications that do not need the newest Bitrix24 REST methods. Choose v3 for PHP 8.4+ projects that need new REST methods and can accept breaking changes. v3 is in active development and changes the endpoint from /rest/ to /rest/api/, so plan migration and regression testing.
- How do I authenticate with the Bitrix24 REST API using this SDK in Laravel?
- The SDK supports token-based authentication and webhooks, and OAuth2 flows for marketplace apps can be built with Laravel's auth or custom OAuth2 logic. You create a service builder from your token and portal URL, then inject it into controllers, jobs, or services. Keep tokens and portal URLs in config/bitrix24.php with .env overrides for sensitive values.
- Can I use bitrix24/b24phpsdk for batch requests and bulk CRM operations?
- Yes, the SDK supports batch requests, and release 3.7.0 adds batch coverage for Services Landing and Services Sale scopes. This is useful for bulk CRM, e-commerce, and landing-page workflows driven by Laravel queues. Batch calls reduce the number of round trips compared with individual REST requests.
- How do I set up a Laravel service provider for the Bitrix24 SDK?
- Register a singleton in a Laravel service provider that returns a service builder created from your configured token and portal. For example, use ServiceBuilderFactory::createServiceBuilderFromToken with values from config('bitrix24.token') and config('bitrix24.portal'). Then type-hint the SDK service in controllers, jobs, and other classes so Laravel resolves it from the container.
- Does the SDK support incremental sync with Bitrix24 REST v3?
- Yes, release 3.7.0 adds REST v3 user history, field-change, and metadata services with cursor-based incremental reads. These are a good fit for Laravel scheduled jobs and queue workers because they support delta sync instead of full polling. You still need to wrap the SDK calls in your own queued jobs and persistence logic.
- How do I handle Bitrix24 portal domain changes securely with this SDK?
- Release 3.7.0 includes PortalDomainUrlChangingEvent with an irreversible deny() method and PortalDomainChangeRejectedException. Wire the event into Laravel's event system or a dedicated listener to veto unsafe portal redirects before credentials change or tokens are sent to the destination. This is important for multi-portal and marketplace-style applications.
- What are the PHP version requirements for bitrix24/b24phpsdk?
- v1 supports PHP 8.2, 8.3, and 8.4 and is marked stable and production-ready. v3 requires PHP 8.4 or 8.5 and is in active development with new REST methods and breaking changes. Pick the branch that matches your PHP version and appetite for migration work.
- Is bitrix24/b24phpsdk production-ready, and how should I test it?
- v1 is stable and production-ready, while v3 is active development with breaking changes. For v3, pilot release 3.7.0 in staging and run regression tests, especially if you migrate from v1 or use IMBot methods affected by deprecations. The project uses CI checks such as phpstan, php-cs-fixer, rector, and license checks, but you should still test your Laravel integration end to end.
Weaver
How can I help you explore Laravel packages today?