Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation:
Connector package documentation
SPS Commerce
Setting up HTTP Client for SPS Commerce
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select SPS Commerce HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI (Example : https://api.spscommerce.com).
- Fill in the Client ID and Secret.
- Press “Grant access to SPS Commerce”
- Save and Continue.
Subscribing to Entities from SPS Commerce
Steps
- Go to Connections → Incoming and create a new incoming configuration and select SPS Commerce Subscriber as the subscriber.
- Select the entity you want to subscribe from SPS Commerce.
- Add any request parameters needed to subscribe to the entity (optional).
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the SPS Commerce HTTP Client to use
General Concept
We follow SPS Commerce documentation on building this connector so you can easily use the connector based on SPS Commerce API Reference.
Entity
It’s the entity you want to subscribe from SPS Commerce. Please refer to the entities in Management APIs from SPS Commerce API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on SPS Commerce API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing “Get Shipping Labels by label ID”
That’s why we need to define the label-id property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. The properties inside payload parameters will be parsed as payload. Here is the final URL that will be called when using such Request Parameters field.
/label/v1/1234567
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access SPS Commerce.
Publishing Entity to SPS Commerce
Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select SPS Commerce Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the SPS Commerce entity you want the data to be published.
- Select the HTTP Client to use.
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).
Entity
We support publishing to most SPS Commerce Command. Please refer to the entities in Management APIs from the SPS Commderce API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For Endpoints that require an object as the request payload, please look at the example below. For example, we want to Delete Transaction. Please select “Delete Transaction” as the entity of the publisher.
You can put the Path object as file-path.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access SPS Commerce.