About the Tweakwise category

anon99371720 · March 27, 2023, 6:51am

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

Extra information

System documentation: Tweakwise Navigator Backend API Reference

Connector package documentation

1. Setting up HTTP Client Tweakwise Navigator Backend

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Tweakwise Navigator Backend Client as the HTTP Client.
Fill in the Base URL, Access Token, and Instance Key to your Tweakwise account.
(For more information, see Tweakwise Backend Support)
You can optionally enable logging of requests to get the authentication log.
Save the HTTP Client for use.

2. Subscribing to Entities from Tweakwise Navigator Backend

2.1 Steps

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

2.2 General Concept

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

Entity

The entity you want to subscribe to Tweakwise Navigator Backend. Please refer to the entities from Tweakwise Navigator Backend API Reference page.

Request Parameters

You can provide these parameters to get the needed entity based on the Tweakwise Navigator Backend API Reference.

Please look at the example below on how to fill the path field when subscribing “Gets an attribute by id”.

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 Tweakwise with the URL /attribute/1

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 Tweakwise Navigator Backend.

3. Publishing Entity to Tweakwise Navigator Backend

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select Tweakwise Navigator Backend Publisher as the publisher.
Select the method that you want the publisher to perform with the data.
Select the Tweakwise Navigator Backend entity you want the data to be published.
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). However, you can also add or modify payload using the Request Transformer.

Method

Currently, we support Post, Patch, Put, and Delete methods on submitting data to Tweakwise Navigator Backend.

Entity

We support publishing to most Tweakwise Navigator Backend endpoints.
Please refer to Tweakwise Navigator Backend API Reference page.

For example, we want to Create a new category. Please select “Post” as the Method and “Creates a new category” as the entity of the publisher.

You can put the payload you want to send to Tweakwise into the payload key in the data. Here is an example of the possible Data for “Creates a new category”.

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.

Alumio will send an API request to Tweakwise with URL /category