Getting started with Emporix API

Introduction

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

You can check the current status of Emporix API services on the Emporix Status Page.

Base URL

Copy
Copied
https://api.emporix.io
info

To start working with our API, make sure to allowlist api.emporix.io IP: 34.128.182.253.

Authorization and scopes

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

API credentials

The Emporix Developer Portal provides you with two types of credentials:

  • Emporix API — used to access the API from a business owner's perspective.
  • Storefront API — used to access the API from a customer's perspective. These credentials are used to perform basic actions on the storefront — browse products, view prices, or add products to a cart.

Types of access tokens

When using our API, you will come across four types of access tokens:

Token typeDescriptionEmporix API endpoint
Anonymous tokenUsed by the storefront to access public resources with a reading scope. It allows customers to browse products, view prices, or add products to a cart. The anonymous token is not associated with any specific customer.Requesting an anonymous token
Customer tokenA JSON Web Token (JWT) which contains encrypted customer data. The customer token works similarly to the anonymous token, but it is associated with a specific customer.Requesting a customer token
Refresh tokenUsed to refresh the customer token.Requesting a refresh token
Service access tokenNeeded to access and manage the Emporix services such as adding new products, managing categories, or modifying prices.Requesting a service access token

Scopes

When you request an access token, you can see a scope field in the response. Scopes define which operations you are allowed to perform and which resources you can access.

The overall naming convention for scopes is [service_name].[resource_name]_[action_name].The action names read and view are used interchangeably and both mean that the scope grants read-only access to a particular resource.

Anonymous, customer, and refresh tokens have a pre-defined set of scopes. You can request specific scopes only when requesting a service access token. To find out which scopes are needed to access a particular endpoint, check its description in the Emporix API Reference.

Some endpoints do not require any scopes as they are implicitly readable.

Quick Start Guide for developers

Before you start

Make sure you have an account on the Emporix Developer Portal.

Retrieve your Emporix API keys

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

  1. Log in to the Emporix Developer Portal.
  2. Go to the Manage API Keys tab.
  3. Copy the Client ID and Secret values from the Emporix API row.

Send a sample request

You can now use your Emporix API keys to authorize requests. Try it out by calling the Retrieving sites endpoint:
Loading...

You should receive your main site's settings in the response body.

warning

If you want to send a request to an endpoint that requires a different set of scopes, you need to generate a new access token.

Explore the Emporix API

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