# Shopware (prebuilt connector)

## Description

**Shopware** is an integrated tool for marketing and creating online shops.

## API documentation

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

<https://developers.shopware.com/developers-guide/rest-api/>

## Authentication&#x20;

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

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

### OAuth 2 (client credentials)

{% tabs %}
{% tab title="Credentials" %}
When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) 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>Username</code></td><td>true</td><td>Your Shopware admin username.</td></tr><tr><td><code>Password</code></td><td>true</td><td>Your Shopware admin password.</td></tr><tr><td><code>Scope</code></td><td>true</td><td>The required scope to define what access permissions should be given to Patchworks. Typically set to <code>write</code>.</td></tr><tr><td><code>Client ID</code></td><td>true</td><td>Always set to <code>administration</code>.</td></tr><tr><td><code>Client Secret</code></td><td>true</td><td>This is the <code>secret access key</code> that's generated when you add an integration to Shopware (so in this case, when you add a Patchworks integration). </td></tr><tr><td><code>Store URL</code></td><td>true</td><td>The URL used to access your Shopware store without the https// element. For example: <a href="https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty"><code>https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty</code></a> would be entered as <a href="https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty"><code>patchworks-vkhliupko.shopware-demo.net/pwa-beauty</code></a></td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>password</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>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Username & password**

Provided when you create a Shopware account.

**Client secret**

When you add an integration to Shopware, a **secret access key** is created - this is your **client secret**.

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FJOkBZk474NHfqHf6b5Oh%2Fshopware%20creds.png?alt=media\&token=c5dc98c3-7c1d-49d7-856f-d5c788659f9e)
{% endtab %}
{% endtabs %}