About the Reamaze category

Alumio_Bot · September 21, 2022, 11:09am

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

Extra information

System documentation: Reamaze API Reference

Connector package documentation

1. Setting up HTTP Client Reamaze

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Reamaze HTTP Client as the HTTP Client.
Fill in the Base URI, Email and Token.
(For more information, see Reamaze API 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 Reamaze

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Reamaze Subscriber as the subscriber.
Select the Reamaze HTTP Client to use.
Select the entity you want to subscribe to from Reamaze.
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 Reamaze.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

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

HTTP Client

The HTTP Client configuration you will use to access Reamaze.

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Articles - Get Article” entity.

Based on the documentation, we can see that the end point require “slug” as a path. That is why we set the “slug” inside the path key in the Request Parameters.

Alumio will then make a request to Reamaze with the URL /articles/the-federalist-papers

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: URL.com - MediaOptions

3. Publishing Entity to Reamaze

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Reamaze Publisher as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Reamaze entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
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 POST, PUT, and DELETE on submitting data to Reamaze.

Entity

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

For example, we want to use “Articles - Updating Articles”. Please select “PUT” as the method and “Articles - Updating Articles” as the entity of the publisher.

Based on the documentation, it requires a “Request Body”. That is why we set the “Request Body” inside the payload key in the data. It also require the path of “slug” that is why we set so in the path key in the data.

Alumio will send an API request to Reamaze with URL /articles/foo

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: URL.com - MediaOptions
Payload is the data contained within a request.