Introduction

The SparkLayer API lets you connect your backend systems (e.g. ERP, CRM, PIM, or iPaas) and send through B2B data such as product and pricing information, customer rules, and much more! 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.

API elements

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 and limited other data (e.g. pack sizes). If you're building a bespoke integration with a custom platform, the integration will be more extensive and require most elements of the Core API to be used.

The SparkLayer API is structured as follows:

Getting started with the API

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.