API Reference
Start typing to search…

Authentication

Authentication Overview

The UC Marketplace API uses Bearer tokens for protected endpoints.
There are two types of tokens:

  1. Integration Token or Admin Token – for marketplace owners and vendor admins
  2. User Token – for storefront customers

Some APIs are public and do not require authentication.

Admin & Vendor Authentication

Option 1: Get Integration Token via Admin Portal

Steps:

  1. Log in to Admin Portal**
  2. Go to System > Extensions > Integrations
  3. Add a new integration
  4. Fill in the following fields:
    • Name: e.g., My API Integration
    • Email: Admin or developer email
    • Callback URL and Identity Link URL: Leave blank unless needed
  5. Under the API tab, choose resource access level:
    • Choose "All" for full access
    • Or select specific resources (e.g., Sales, Catalog, etc.)
  6. Click Save.
  7. On the Integrations page, click "Activate" next to the newly created integration.
  8. Click "Allow" on the confirmation dialog.
  9. A modal will display:
    Access Token (used in REST API) Access Token can be used as Bearer Token.

Notes

  • Integration tokens are issued to platform administrators via the Admin Portal.
  • Keep your integration token secure and avoid sharing it.

Option 2: Get Token via API

Provide Marketplace Owner or Vendor Admin credentials in the request payload to obtain a token using the following endpoint:
👉 API Endpoint for Generating Admin Token


Storefront API Authentication