During one of our recent implementations, CRM Bitrix24 was used as a backend for another external system - for a student's account. Through an account interface, students can apply for training in the chosen course, upload the necessary documents, monitor the status of their application, pay tuition bills, and also interact with their curators. All this is very deeply integrated with Bitrix24 business processes. For such a deep integration of Bitrix with a third-party system, we lacked standard REST methods - the logic for using requests became too complicated and confusing.
Before we were hired for the project, a lot of logic had already been implemented on the side of the student's account, which made it too closely related to Bitrix24 and violated the principles of SOLID development.
The solution was to write our own REST methods. Of course, it may seem to someone that one could simply create a public page that will return the result to an external request in the form of a JSON object, but this approach is wrong for several reasons:
1. It may not be safe.
2. This is not convenient, since in the external system during integration you will have to write requests to standard REST methods and to such pages in different ways.
Fortunately, the Bitrix24 developers have provided the ability to write their own REST methods to extend the standard ones. It's very simple. We write our own provider class for our methods:
And we register it in php_interface by hanging an event handler:
Everything is ready.
The CustomRestProvider class contains the OnRestServiceBuildDescription method, which is called on the event of the same name. This method returns an array whose keys are your new scope and whose values are an array of methods of this scope. You can work with scope in the same way as with standard ones.
Now we can access the custom.hello.world method just like standard REST methods. Don't forget to give new scope permissions to your webhooks!
Comments
Post a Comment