About the MyDeal category

o.plokha · April 15, 2024, 9:15am

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

Extra information

System documentation: MyDeal Universal API Reference

Connector package documentation

1. Setting up HTTP Client MyDeal Universal

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select MyDeal Universal HTTP Client as PlatForm and click next step
Fill in the Base URI, Seller ID, Seller Token, Client ID and Client Secret.
Click on “Grant access to MyDeal Universal” and key will be generated.
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 MyDeal Universal

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “Retrieve Single Order” entity.

From the end point, we can see that we need to set “id” as parameters. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to MyDeal Universal with the URL /orders/136539120

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

HTTP Client

The HTTP Client configuration you will use to access MyDeal Universal.

3. Publishing Entity to MyDeal Universal

3.1 Steps

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

Entity

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

For example, we want to Cancel Order. Please select “Post” as the Method and “Cancel Order” as the entity of the publisher.

From the end point, we can see that we need to set “id” as parameters. That is why we set the “id” inside the path key in the data.
Based on the documentation, it requires a request body. That is why we set the request body in the payload key inside Alumio data.

Alumio will send an API request to MyDeal Universal with URL /orders/136539120/cancel

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.