About the LimeCRM category

anon99371720 · September 21, 2022, 11:15am

Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Lime CRM API Reference

Connector package documentation

1. Setting up the HTTP Client Lime CRM

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Lime CRM Client as the HTTP Client.
Fill in the Base URI and X API Key.
(For more information, see Lime CRM Authentication Reference)
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 Lime CRM

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select the Lime CRM Subscriber as the subscriber.
Select the Lime CRM HTTP Client to use.
Select the entity you want to subscribe to from Lime CRM.
Add any request parameters needed to subscribe to the entity.
(Optional) Add a transformer to modify the request parameters into something you will request from Lime CRM.
(Optional) Enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow Lime CRM documentation for building this connector, so you can easily use the connector based on the Lime CRM API Reference.

HTTP Client

This is the HTTP Client configuration you will use to access Lime CRM.

Entity

This is the entity you want to subscribe to Lime CRM. Please refer to the entities from the Lime CRM API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Lime CRM API Reference.

Follow the example below to fill the path field when subscribing to “Retrieve a company” entity.

Based on the documentation, we can see that the endpoint requires “id” as a path. That is why we set the “id” inside the path key in the Request Parameters.

“Path” is the path parameter of the url. For example the {id}.
“Query” is a defined set of parameters attached to the end of a URL.
Example: www.url.com?type=true&start=0

Alumio will then make a request to Lime CRM with the URL /company/123

3. Publishing Entity to Lime CRM

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Lime CRM Publisher as the publisher.
Select the Action that you want the publisher to perform with the data.
Select the Lime CRM entity you want the data to be published to.
(Optional) Add any path data to the request on the key path.
(Optional) Add any query data to the request on the key query.
(Optional) 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 the 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 Lime CRM.

Entity

We support publishing to most Lime CRM endpoints.
Please refer to the Lime CRM API Reference page.

For example, we want to update a person. Please select “Update” as the Action and “Update an existing person” as the entity of the publisher.

Based on the documentation, we can see that the endpoint requires “id” as a path. This is why we set the “id” inside the path key in the data. Based on the documentation as well, it requires a “Request Body”. That is why we set the “Request Body” inside the payload key in the Request Parameters.

Alumio will send an API request to Lime CRM with URL /person/1

“Path” is the path parameter of the URL. For example the {id}.
“Query” is a 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.