# OnBuy (prebuilt connector)

## Description

**OnBuy** is an online marketplace connecting buyers with business sellers (and vice versa).

## API documentation

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

{% embed url="<https://docs.api.onbuy.com/#api-methods>" %}

## Authentication&#x20;

When adding connector instances for **OnBuy**, 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>Consumer key</code></td><td>true</td><td>The API consumer key can be found in your OnBuy Seller Panel.</td></tr><tr><td><code>Consumer secret</code></td><td>true</td><td>The API consumer secret can be found in your OnBuy Seller Panel.</td></tr><tr><td><code>Scope</code></td><td>true</td><td>Set to <code>none</code>.</td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>client_credentials</code>.</td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
To obtain your OnBuy API credentials, follow the steps below:

**Step 1**\
Log in to your OnBuy seller portal.\
\
**Step 2**\
Navigate to `Listing` *>* `Imports & Integrations`:\
\ <img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FhLHzaPZV62qDsQNbbq6U%2FOnBuy%201.png?alt=media&#x26;token=8116d71a-6774-465b-8239-ab3534e1f689" alt="" data-size="original">

**Step 3**\
Enable the `OnBuy API` integration. In the section Connection Details, find the necessary information.

**Step 4**\
Check the `connection details` section for your API credentials:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FXDvnVNLKT9I9yMomAGqM%2Fonbuy%202.png?alt=media&#x26;token=3c5975a4-09a5-4bee-ae04-bda5f906bf6c" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}
