Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: OpenCart API Reference
- 1. Setting up HTTP Client OpenCart
- 1.1 Steps
- 2. Subscribing to entities from OpenCart
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to OpenCart
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client OpenCart
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
- Select OpenCart HTTP Client as PlatForm and click next step
- Fill in the Base URL, Username and API Key.
(See the OpenCart Documentation) - 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.
Note : It is recommended to use Alumio Environment variables as the example shown.
2. Subscribing to Entities from OpenCart
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “OpenCart Subscriber” as the subscriber.
- Select the OpenCart HTTP Client to use.
- Select the entity you want to subscribe to from OpenCart.
- Fill any data that you want to send to OpenCart.
- You can optionally add a transformer to transform the request parameters into something you will request from OpenCart.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
2.2 General Concept
We follow OpenCart documentation on building this connector, so you can easily use the connector based on OpenCart API Reference.
HTTP Client
The HTTP Client configuration you will use to access OpenCart.
Entity
The entity you want to subscribe to OpenCart. Please refer to the entities from OpenCart API Reference page. As this Connector Package created OpenCart only accept POST method for the request.
Please look at the example below on how to retrieve available shipping methods by using “Shipping - Returning available shipping methods” entity.
Alumio will then make a request to OpenCart with the URL
index.php?route=api/shipping/methods
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select “OpenCart Publisher” as the publisher.
- Select the HTTP Client to use.
- Select the OpenCart entity you want the data to be published to.
- Fill any data that you want to send to OpenCart.
3.2 General Concept
Like the subscriber, the publisher has similar methods on how to use it.
HTTP Client
The HTTP Client configuration you will use to access OpenCart.
Entity
We support publishing to all OpenCart endpoints.
Please refer to OpenCart API Reference page.
As this Connector Package created OpenCart only accept POST method for the request.
For example, we want to apply an existing coupon. Please select “Coupon - Apply existing coupon” and add data with Key “coupon” and the value of the code after OpenCart Data type.
Alumio will send an API request to OpenCart with URL
index.php?route=api/coupon