Intro
The SparkLayer API lets you connect your backend systems (e.g. ERP, CRM, PIM, or iPaas) and send through B2B data such as pricing information! Once you've completed the API integration, you can then install the SparkLayer Frontend, converting your eCommerce website into a powerful B2B ordering system.
The SparkLayer API follows REST principles with OAuth2 authentication, allowing you to tightly integrate with your backend systems. Our API Docs give a complete overview of how to integrate with SparkLayer and we've also included some key information below.
Please note: Access to the SparkLayer API is only available on our Pro and Enterprise plans.
The SparkLayer API can be used to connect to a wide range of data and the extent will depend on your integration and the systems you intend to use.
For example, if you're using one of the supported platform integrations (e.g. Shopify), SparkLayer will automatically be able to retrieve product and customer data from the platform itself. In this scenario, the SparkLayer API will only be used to send through Product price list data primarily. If you're building a bespoke integration with a custom platform, the integration will be more extensive and require some elements of the Purchasing API and the Core API to be used.
If you are looking to use another API outside of the Pricing API, it's recommended to us on the technical approach, please contact us to arrange a call.
The SparkLayer API is structured as follows:
Area | Details |
|---|---|
Pricing API | The SparkLayer Pricing API is typically used to automate your pricing data into SparkLayer. You can learn more about how it works in the here. |
The SparkLayer Purchasing API is typically used to update orders visible to the customer. You can learn more in the here | |
Core API | The SparkLayer Core API provides support for a wider range of data elements (e.g., products, customers ). You can learn more in the here. |
Integrating with the SparkLayer API will require technical expertise and our recommendation is to review our SparkLayer API Docs in detail before beginning the process.
Please note: Before starting, you'll need your unique Site ID which can be found in the SparkLayer Dashboard My Account section and you'll also need to generate your unique API keys here. If you have any technical questions about how best to integrate with the SparkLayer API, please contact us here and we'll be happy to assist