Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Bitrix24 API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Bitrix24
- 1.1 Steps
- 2. Subscribing to entities from Bitrix24
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Bitrix24
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client Bitrix24
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “Bitrix24 HTTP Client” as the HTTP Client.
- Fill in the Base URI, Client ID, Client Secret, and Scopes (Optional).
(For more information, see Bitrix24 Authentication Reference) - Click on “Grant access to Bitrix24” to get the Key.
- You can optionally enable logging of request to get the log of the authentication.
- Save the HTTP Client for use.
2. Subscribing to Entities from Bitrix24
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “Bitrix24 Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Bitrix24.
- Add any request parameters needed to subscribe to the entity.
- You can optionally add a transformer to transform the request parameters into something you will request from Bitrix24.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
- Select the Bitrix24 HTTP Client to use.
2.2 General Concept
We follow Bitrix24 documentation on building this connector, so you can easily use the connector based on Bitrix24 API Reference.
Entity
The entity you want to subscribe to Bitrix24. Please refer to the entities from Bitrix24 API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Bitrix24 API Reference.
Please look at the example below on how to fill path field when subscribing “Sale Order Get” entity.
Based on the documentation, we can see that the end point require “id” as a parameter. That is why we set the “id” inside the payload key in the Request Parameters.
- Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0 - Payload is the data contained within a request.
Alumio will then make a request to Bitrix24 with the URL /rest/sale.order.get.json
HTTP Client
The HTTP Client configuration you will use to access Bitrix24.
3. Publishing Entity to Bitrix24
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select “Bitrix24 Publisher” as the publisher.
- Select the Action that you want the publisher to perform with the data.
- Select the Bitrix24 entity you want the data to be published to.
- You can optionally add any query data to the request on the key query.
- You can optionally add any payload data to the request on the key payload.
- Select the HTTP Client to use.
3.2 General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.
Action
Currently, we support Create (HTTP POST method), Update (HTTP PUT method) and Delete (HTTP DELETE method) on submitting data to Bitrix24.
Entity
We support publishing to most Bitrix24 endpoints.
Please refer to Bitrix24 API Reference page.
For example, we want to add a new sale paysystem. Please select “Create” as the Action and “Sale Paysystem Add” as the entity of the publisher.
Based on the documentation, we need to add fields. So we put the fields inside the payload key in the Data.
Alumio will send an API request to Bitrix24 with URL /sale.paysystem.add.json
- Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0 - Payload is the data contained within a request.
HTTP Client
The HTTP Client configuration you will use to access Bitrix24.