code-branchEmporix API

Get familiar with Emporix API.

API Quickstart

Download API references:

down-to-lineDownload all Emporix API Specs - ZIP

For easier testing of Emporix API, check out the Postman Collection with example flows:

Introduction

The Emporix API is the core of our Commerce Engine designed to help you easily manage your business's resources. It is organized around REST and makes use of the following components:

  • OAuth 2.0arrow-up-right token-based authorization

  • Resource-oriented URLs

  • HTTP request methods

  • JSON-encoded requests and responses

  • HTTP status codes

You can check the current status of Emporix API services on the Emporix Status Pagearrow-up-right.

Base URL

circle-exclamation

Authentication and authorization scopes

The Emporix API incorporates OAuth 2.0arrow-up-right token-based authorization. API keys are used to generate access tokens, which are then used to authorize HTTP methods.

circle-info

To get familiar with the authentication and access scopes, refer to the Tokens and Scopes guide.

Customer audit logs

You can request customer audit logs from Emporix by reaching out to our Support Teamenvelope and sending the email request. The logs are kept for the last 712 days. You can retrieve information about create, update or delete operations. The records contain information about the tenant, timestamp and the person who performed the actions.

Quick start guide for developers

Before you start

Make sure you have an account on the Emporix Developer Portalarrow-up-right.

Retrieve your Emporix API keys

To access the Emporix API, you first need to retrieve your API keys. Perform the following steps:

2

Go to the Manage API Keys tab and copy the Client ID and Secret values from the Emporix API.

3

Authenticate and authorize yourself by obtaining the service token. See more details in the OAuth Service Tutorial. For example:

4

Send a sample request. For example, create a basic product:

triangle-exclamation

Explore the Emporix API

You're all set! You can now interact with the Emporix API.

Last updated

Was this helpful?