Types Of Add-Ons
There are two types of add-ons you can develop with Maropost Commerce Cloud, public and custom. The type of add-on that you develop largely depends on the size of your intended audience and also their nature.
A public add-on is listed in the add-on store that every merchant can find in their Maropost Commerce Cloud control panel. This type of add-on is ideal for developers who are creating something that fits a general need that does not require much customisation. If you are a developer for an existing SaaS solution and are looking at integration with Maropost Commerce Cloud, you are likely creating a public add-on. With this type of add-on:
- Merchants can install your add-on directly from the control panel.
- Your add-on must be approved by Maropost.
- Your add-on must authenticate to the Maropost Commerce Cloud API using OAuth.
- Your add-on can be billed through a merchant’s Maropost Commerce Cloud subscription, or through your own.
- You can include front-end (webstore) scripts and markup in the installation process.
- You can include any type of data export in the installation process.
You can browse existing public add-ons in our add-on store here.
To be listed in our add-on store, additional terms and conditions apply. Please contact us here.
A custom add-on is usually built with a single or specific merchant in mind. If you are a developer who is creating a connector for a merchant or automation for a specific use case, you are likely creating a custom add-on. With this type of add-on:
- Merchants cannot install your add-on directly from the control panel.
- Your add-on will authenticate to the Maropost Commerce Cloud API using an API key.
- You will bill the merchant directly for your add-on and services.
- You must install all elements of your add-on for each merchant yourself.
Looking for a developer to help with a custom add-on or integration? You can look through our Partner Directory here.
Components of an Add-on
All add-ons that interact with the Maropost Commerce Cloud API must be hosted on your own infrastructure. Your add-on may include a usable interface which may be hosted and viewed on your domain, or it may be embedded into a merchant’s control panel as an iframe.
An add-on may comprise of one or many components, such as:
- API Integration
- Custom scripts for the webstore. Including but not limited to:
- Tracking / marketing scripts
- Chat boxes
- Search interfaces
- Product widgets
- Data Feeds in delimited, json or XML format. HTTP accessible or available by FTP.
The API can be authenticated using an API key that a merchant provides you directly or a secret key can be obtained in the OAuth process for public add-ons.
Custom scripts and data feeds can be installed on a merchant’s account when they install your add-on.
For specific examples of an add-on see the following:
- Reviews add-on
- 3PL add-on
- Customer support add-on