# API Introduction

An overview of the Project Agora Commerce API for integrators.

Before you can integrate with Project Agora Commerce, you will need a Retailer team created for you. Contact Project Agora Commerce to create integration teams.

## Project Agora Commerce Endpoints <a href="#citrusad-endpoints" id="citrusad-endpoints"></a>

Project Agora Commerce uses various endpoints to sync data and generate ads. A brief summary is below:

| Endpoint            | Use               | Description                                              |
| ------------------- | ----------------- | -------------------------------------------------------- |
| catalogs \*         | Syncing catalogs  | Used to create catalogs Via API                          |
| catalog-products \* | Syncing products  | Used to create and update product data within a catalog  |
| customers \*        | Syncing customers | Used to create and update customer data within a catalog |
| orders              | Sending orders    | Used to send order data to Project Agora Commerce        |
| generate            | Generating ads    | Used to generate product ads and banner ads              |
| bannerx             | Generating ads    | Used to generate banner x ads                            |

{% hint style="info" %}
You do not need to use endpoints for catalog, product, customer and order syncing. Project Agora Commerce supports syncing data via file which may be suitable for larger integrators.
{% endhint %}

## Content Type & Payload <a href="#content-type-and-payload" id="content-type-and-payload"></a>

The data payload is in JSON format. The `Content-Type` for these endpoints is `application/json`, which should be passed as a header in your requests:

```
-H "Content-Type: application/json" \
```

## Authenticating Requests <a href="#authenticating-requests" id="authenticating-requests"></a>

Project Agora Commerce uses basic authentication, this should be passed as a header with your API key:

```
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
```

For backend integrations, you will only need the secret API key. You can locate your API key within the Project Agora Commerce Portal.

## Base URLs <a href="#base-urls" id="base-urls"></a>

Project Agora Commerce uses different base URLs for staging, as well as different production environments.

Contact Project Agora Commerce to receive the staging Base URL. Production Base URLs are provided when you have completed your staging integration.


---

# 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://developers-commerce-v2.projectagora.com/integration/api-introduction.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.