Key Provisions

The Bitrix24 API reference contains descriptions of all methods and events of the REST API, as well as a number of additional topics important for a deep understanding and effective use of the API in development.

Reading Sequence of MaterialsReading Sequence of Materials

Key sections of the API that provide an overview of the most important features:

To facilitate the process of studying and using the Bitrix24 REST API, the following reading sequence of materials is suggested:

1. Authorization in REST: This section will help you quickly check how the REST API works and familiarize you with the basic principles of making requests.
2. Data Types and Parameter Formats in REST API: Understanding the data types used in the REST API is critically important for correctly working with methods and events.
3. Complete OAuth 2.0 Authorization Protocol: This section describes the authorization mechanisms based on the OAuth 2.0 standard, obtaining and renewing tokens in applications.
4. Installation Options for Applications in Bitrix24 and Deleting Applications: This section discusses the processes of installing and uninstalling applications in Bitrix24 accounts, which is especially important for developers of mass-market applications.
5. Method Permissions: It explains the specifics of application and webhook access to various REST API methods, allowing you to configure the necessary level of access.
6. Widget Embedding Mechanism: This section describes ways to integrate custom widgets into the Bitrix24 interface to enhance its functionality.
7. Concept and Benefits of Event Processing: This section is dedicated to the REST API event mechanism, which allows tracking changes in data and responding to them with special server handlers.
8. Interactive Applications: It discusses ways to create interactive applications that utilize the REST API capabilities for interaction between back-end applications and their front-end.
9. Limits: Important aspects related to application performance and limitations imposed on the use of the REST API.
10. Connecting and Using BX24.js: A section dedicated to the JavaScript SDK, which simplifies working with the REST API on the client side.
11. Loading and Using CRest PHP SDK: An overview of the PHP SDK for working with the REST API, providing convenient tools for server-side development.
12. Differences in Using REST API in Cloud and On-Premise Bitrix24: It clarifies the key differences between cloud and on-premise versions of the platform in terms of using the REST API.
13. General Methods and Events: A description of common methods available in the REST API that can be used in various applications.

Bitrix24 ToolBitrix24 Tool

Bitrix24 is a comprehensive product that combines many different tools that are integrated with each other. This integration allows developers to offer users complete business scenarios using multiple tools.

The API reference contains descriptions of available methods, events, and widgets for the corresponding Bitrix24 tools.

1. General Methods and Events
2. Overview of CRM
3. AI in Bitrix24
4. News Feed
5. Online Store
6. Users
7. Workflows
8. Tasks
9. Document Generator
10. Calendar: Overview of Methods
11. Payment Systems
12. Company Structure: Overview of Methods
13. Working with Agreements
14. Workgroups and Projects
15. Open Lines
16. Chatbots
17. Chats
18. Sites and Stores
19. Message Providers, SMS Providers
20. Universal Lists
21. Time Tracking
22. Data Storage
23. Product Catalog
24. Telephony
25. Drive
26. Mail Services