Algolia

​

Extra information

System documentation: Algolia API Reference

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client Algolia
  • 1.1 Steps
• 2. Subscribing to entities from Algolia
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Algolia
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client Algolia

1.1 Steps

1. In Algolia Dashboard, go to Settings -> Organization Settings -> Teams and Access -> API Keys. You can manage the Application ID, and API Keys. Please make sure you choose the right API keys for your need. (For more information, see Algolia API Keys)
2. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select Algolia Client as the HTTP Client.
3. Fill in the Base URI, Algolia Application ID, and Algolia API Key. (For more information, see Algolia Hosts)
4. You can optionally enable logging of request to get the log of the authentication.
5. Save the HTTP Client for use.

​

2. Subscribing to Entities from Algolia

2.1 Steps

1. Go to Connections -> Incoming, create a new incoming configuration, and select Algolia Subscriber as the subscriber.
2. Select the entity you want to subscribe to from Algolia.
3. Add any request parameters needed to subscribe to the entity.
4. You can optionally add a transformer to transform the request parameters into something you will request from Algolia.
5. Select the Algolia HTTP Client to use.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept We follow Algolia documentation on building this connector, so you can easily use the connector based on Algolia API Reference. Entity The entity you want to subscribe to Algolia. Please refer to the entities from Algolia API Reference page. Request Parameters You can provide these parameters to get the needed entity based on the Algolia API Reference. Please look at the example below on how to fill the path field when subscribing “Search Index” entity. Based on the documentation, we can see that the endpoint requires “indexName” as a path. That is why we set the “indexName” 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 Algolia with the URL /1/indexes/123 Input Transformer Any transformer’s set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. HTTP Client The HTTP Client configuration you will use to access Algolia.

​

3. Publishing Entity to Algolia

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Algolia Publisher as the publisher.
2. Select the action that you want the publisher to perform with the data.
3. Select the Algolia entity you want the data to be published.
4. You can optionally add any path data to the request on the key path.
5. You can optionally add any query data to the request on the key query.
6. You can optionally add any payload data to the request on the key payload.
7. 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). However, you can also add or modify the payload using the Request Transformer. Action Currently, we support Create (HTTP POST method), Update (HTTP PUT method), Patch (HTTP PATCH Method), and Delete (HTTP DELETE method) on submitting data to Algolia. Entity We support publishing to most Algolia endpoints. Please refer to Algolia API Reference page. For example, we want to use “Delete object” entity. Please select “Delete” as the Action and “Delete object” as the entity of the publisher. Based on the documentation, we can see that the endpoint requires “indexName” and “objectID” as a path. That is why we set the “indexName” and “objectID” inside the path key in the data. Alumio will send an API request to Algolia with URL /1/indexes/contacts/myID. Another example is when we want to use “Add/replace object (with ID)” entity. Please select “Update” as the Action and “Add/replace object (with ID)” as the entity of the publisher. You can put the payload you want to send to Algolia into the payload key in the data. Here is an example of the possible Data for “Add/replace object (with ID)”. Alumio will send an API request to Algolia with URL /1/indexes/contacts/myID.

• 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.

HTTP Client The HTTP Client configuration you will use to access Algolia.