About the FreeAgent category

anon99371720 · October 12, 2023, 7:23am

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

Extra information

System documentation: FreeAgent API Reference

Connector package documentation

1. Setting up HTTP Client FreeAgent

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select FreeAgent HTTP Client as PlatForm and click next step
Fill in the Base URI, Client ID and Client Secret.
(For more information, see FreeAgent Authentication Reference)
Click on “Grant access to FreeAgent” and you will be redirected to approve the grant.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from FreeAgent

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “FreeAgent Subscriber” as the subscriber.
Select the entity you want to subscribe to from FreeAgent.
Add any request parameters needed to subscribe to the entity.
Select the FreeAgent HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from FreeAgent.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

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

Entity

The entity you want to subscribe to FreeAgent. Please refer to the entities from FreeAgent API Reference page.

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Contacts - Show Contact” 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 path key in the Request Parameters.

Alumio will then make a request to FreeAgent with the URL /v2/contacts/15978986

Path is the path parameter of the url. For example the {id}.
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 FreeAgent.

3. Publishing Entity to FreeAgent

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “FreeAgent Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the FreeAgent 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.

Method

Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to FreeAgent.

Entity

We support publishing to most FreeAgent endpoints.
Please refer to FreeAgent API Reference page.

For example, we want to add a new contact. Please select “Post” as the Method and “Contacts - Create Contact” as the entity of the publisher.

Based on the documentation, it requires a payload with root contact element. That is why we set the payload inside the payload key in the data with a root contact element.

Alumio will send an API request to FreeAgent with URL /v2/contacts

Another example is when we want to delete a contact. Please select “Delete” as the Method and “Contacts - Delete Contact” as the entity of the publisher.