# 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](/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>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="/files/vi1v80vluGoe90j6LHkp" 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="/files/pK0YwSJsChD77m0Q5ZlK" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# 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/onbuy-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.
