Tutorials: Ready-made Use Cases for REST API
Tutorials are a practical guide for developers on the Bitrix24 REST API. They help solve typical tasks: creating or modifying entities, setting up integrations with external systems.
How to Use Tutorials
-
As educational material for making your first requests. Suitable for developers who are starting to work with the Bitrix24 REST API. Tutorials will help you understand how to form requests and process responses. For example, the tutorial How to Attach a Task to a SPA.
-
As templates for real scenarios. Tutorials can be used as a basis for your own solutions: adapt the examples to your needs, add error handling logic, logging. For example, the tutorial How to Create an Open Channel Connector for Chat on the Site.
-
For quickly solving specific tasks. Tutorials will help you find a ready-made code example that you can use immediately. For example, the tutorial How to Set Up Rounding for a Custom Number Field.
Structure of Tutorials
Tutorials consist of:
- a brief description of the task being solved,
- examples of methods in PHP and JavaScript,
- descriptions of the parameters used,
- examples of server responses in JSON format,
- examples of general code for applications in PHP and JavaScript,
- explanations and tips,
- links to related articles.
Tips for Beginners
Explore the sections Getting Started, How to Make Your First Request.
Start with simple scenarios, such as filtering data in the tutorial How to Filter Elements by Stage Name. It does not use methods for modifying or deleting entities, so the data within the entities will be safe.
Example algorithm for working with the section:
- Select a category from the menu that interests you, such as CRM.
- Find the tutorial that corresponds to your task.
- Follow the step-by-step instructions and examples.
- Adapt the code to your needs.
- Check the result and ensure everything works.
- Contact Bitrix24 Support if you encounter difficulties.
Categories of Tutorials
|
How to work with CRM entities: contacts, deals, SPAs, custom fields, widgets, and Sales Intelligence |
|
|
How to integrate trading functions: create product items, set up delivery, implement a cash register |
|
|
How to embed actions, complete processes, configure Automation rule parameters |
|
|
How to add a custom prompt |
|
|
How to create a chatbot, configure it for Open Channels, create a support channel |
|
|
How to implement custom scenarios for integration with a call center |
|
|
How to create tasks with files, attach them to SPAs, add comments |
|
|
How to create a connector for online chat on the site and integrate it with Bitrix24 |
How to Provide Feedback on Tutorials
If you want to add your scenario or improve an existing one:
- send a pull request with your solution to the documentation repository,
- write an issue with your idea suggestion.