About the Scayle category

anon99371720 · March 11, 2024, 8:13am

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

Extra information

System documentation: Scayle API Reference

Connector package documentation

1. Setting up HTTP Client Scayle

1.1 Steps

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

2.1 Steps

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

2.2 General Concept

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

HTTP Client

The HTTP Client configuration you will use to access Scayle.

Entity

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

Request Parameters

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

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

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

Alumio will then make a request to Scayle with the URL /products/141

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.

3. Publishing Entity to Scayle

3.1 Steps

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

Entity

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

For example, we want to update an existing brand. Please select “Put” as the Method and “Brands - Update an existing brand” as the entity of the publisher.

Based on the documentation, it requires a path of “brandId” and a “Request Body”. That is why we set the path “Request Body” inside the payload key in the data.

Alumio will send an API request to Scayle with URL /brands/11347

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.