# SparkLayer (prebuilt connector)

## Description

**SparkLayer** enables powerful B2B ordering on major eCommerce platforms.

## API documentation

API documentation for SparkLayer (used to build this connector) can be found via the link below:

{% embed url="<https://docs.sparklayer.io/sparklayer-api>" %}

## Authentication&#x20;

When adding connector instances for SparkLayer, the following authentication methods are supported:

* [OAuth 2 (client credentials)](#oauth-2-authorisation-code)

### OAuth 2 (client credentials)

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **OAuth 2 (client credentials)** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Scope</code></td><td>true</td><td>The required scope to define what access permissions should be given to Patchworks.</td></tr><tr><td><code>Client ID</code></td><td>true</td><td>The reference given when the Patchworks app was created for SparkLayer.</td></tr><tr><td><code>Client secret</code></td><td>true</td><td>The client secret which was issued when the Patchworks app was created for SparkLayer.  </td></tr><tr><td><code>Environment name</code></td><td>true</td><td>Your SparkLayer environment.</td></tr><tr><td><code>Site-id</code></td><td>true</td><td>Your SparkLayer site id.</td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>client_credentials</code>.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Set to <code>access_token.</code></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/sparklayer-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.