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

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

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.

Content Type & Payload

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

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

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.