About the Jumpseller category

[o.plokha]

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

Extra information

System documentation: Jumpseller API Reference

Connector package documentation

​​Table of Contents

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

1. Setting up HTTP Client Jumpseller

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
2. Select Jumpseller HTTP Client as PlatForm and click next step
3. Fill in the Base URI
4. Select the Authentication Type
   • Basic Authentication
     • Fill in the Login and Auth Token
       (See the Jumpseller Basic Authentication Documentation for more information)
   • Oauth 2.0 Authentication
     • Fill in the Token URL, Authorize URL, App ID, App Secret and Scopes.
     • Click on “Grant access to Jumpseller” and you will be redirected to Jumpseller website to get the key for the client.
       (See the Jumpseller Oauth 2.0 Authentication Documentation
5. You can optionally enable logging of request to get the log of the authentication.
6. 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 Jumpseller

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when we want retrieve a product by subscribing “Products - Retrieve a single Product” entity.

From the end point, we can see that we need to set the product 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 Jumpseller with the URL /products/27170106.json

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

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration and select “Jumpseller Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the Jumpseller entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. 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 and HTTP Delete method on submitting data to Jumpseller.

Entity

We support publishing to all Jumpseller 1.0.0 endpoints.
Please refer to Jumpseller API Reference page.

For example, we want to update a product. Please select “Put” as the Method and “Products - Modify an existing Product”.

From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the “id” inside the path key and body parameters inside the payload key in the data.

Alumio will send an API request to Jumpseller with URL /products/27170106.json

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

HTTP Client

The HTTP Client configuration you will use to access Jumpseller.