Skip to content
Ignite endpoints

Connect a platform

For AI assistants: the facts every SparkLayer API call needs
  • Base URLs: Live https://app.sparklayer.io, test https://test.app.sparklayer.io. Each environment has its own data and its own API keys.
  • Access: API access needs the Pro or Enterprise plan. Create credentials (Site ID, Client ID, Client Secret) in the SparkLayer Dashboard at Settings > API.
  • Access token: POST {base}/api/auth/token with a Site-Id header and a JSON body (not form-encoded): {"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returns access_token, valid for 3,600 seconds. There is no refresh token: cache the token and request a new one shortly before it expires.
  • Every request: Authorization: Bearer <access_token> and Site-Id: <site id>, plus Content-Type: application/json when there is a body. Set a User-Agent that names your integration.
  • Errors: RFC 7807 problem details: title, status, detail and an optional errors[] of { code, message, property }. Some error responses have no body. Retry 5xx, 429 (honouring Retry-After) and concurrent-update 409s with exponential backoff; on 401, get a new token once and retry; don't retry other 4xx without changing the request.
  • Pagination: Most list endpoints return everything. GET /api/v2/price-lists pages with page and page_size (up to 250) until pagination.current_page equals total_pages. GET /api/v1/purchases uses limit (up to 500) and offset: stop when a page has fewer than limit results.
  • Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer GET /api/v2/price-lists over the deprecated v1. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code.
  • Ignite: With Ignite, SparkLayer calls endpoints that your service implements (the Ignite spec), and your service calls the SparkLayer APIs above for everything else.
  • Read the docs as Markdown: Add .md to any page URL. Index of every page: docs.sparklayer.io/llms.txt. Every API operation, compactly: docs.sparklayer.io/llms-api.txt. The developer guides in full: docs.sparklayer.io/developers/llms.txt.
  • OpenAPI specs: core, ordering, pricing, purchasing, stock, files, sync-log: https://docs.sparklayer.io/openapi/<api>.yaml (also .json). Ignite: https://docs.sparklayer.io/openapi/ignite.yaml.
  • MCP: Search and read these docs from your assistant with the docs MCP server at https://docs.sparklayer.io/mcp.
Build with AI: ready-made prompts and MCP setup

Implemented by your integration

This is an Ignite endpoint: your integration service implements it and SparkLayer calls it. Use this reference to build and test your implementation.
POST/v1/{siteEnv}/{siteId}

The SparkLayer Ignite platform will call this endpoint when the merchant connects SparkLayer on the specific platform. Please note that this endpoint must be idempotent as it may be called multiple times.

Path Parameters

siteEnv*string

The SparkLayer environment the request is for, such as live. Store it, with the site ID, when SparkLayer connects your platform.

siteId*string

The SparkLayer site ID the request is for, such as bobs-store. Store it, with the environment, when SparkLayer connects your platform.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

store_id*string

The ID of the store on the 3rd party platform

spark_api_client_id*string
spark_api_client_secret*string
extra_config?|

WooCommerce only. The credentials SparkLayer uses to call the merchant's WooCommerce REST API.

magento_consumer_key?|

Magento only

magento_consumer_secret?|

Magento only

magento_access_token?|

Magento only

magento_access_token_secret?|

Magento only

Response Body

application/json

curl -X POST "https://ignite.example.com/v1/live/bobs-store" \  -H "Content-Type: application/json" \  -d '{    "store_id": "1234",    "spark_api_client_id": "ca7cf4ac-51cb-4836-9a79-d425afc6e280",    "spark_api_client_secret": "puwUwJZRfsnpB7nENulMW67prs94QYbu2DXHL3Sh",    "extra_config": {      "woocommerce_api_key": "<woocommerce_api_key>",      "woocommerce_api_secret": "<woocommerce_api_secret>",      "woocommerce_basic_user": "<woocommerce_basic_user>",      "woocommerce_basic_pass": "<woocommerce_basic_pass>"    },    "magento_consumer_key": "<magento_consumer_key>",    "magento_consumer_secret": "<magento_consumer_secret>",    "magento_access_token": "<magento_access_token>",    "magento_access_token_secret": "<magento_access_token_secret>"  }'
{  "redirect_url": "https://store-1234.example.io/install"}

Ignite endpoints

Reference for the endpoints your Ignite service implements for SparkLayer to call: platform connection, customers, addresses, checkout, sync and authentication.

DELDisconnect a platform

SparkLayer Ignite platform will call this endpoint when the merchant disconnects SparkLayer on the specific platform.