Storefront API Keys in O2VEND

To consume O2VEND Storefront APIs, a Storefront API Key must first be generated from the O2VEND Back Office. Without this key, Storefront API requests cannot be authorized.

Storefront API endpoints are exposed using the following URL structure:

https://{your-store-domain}/docs/api/

This tutorial explains, step by step, how to generate a Storefront API Key from the O2VEND Back Office.

These keys allow external websites, mobile apps, or custom storefronts to securely connect to O2VEND and access storefront data such as products, orders, customers, and other Storefront API Data.

Storefront API Keys Navigation Path

To access Storefront API Keys:

Back Office → Integrations → ApiKey

Then select Storefront API Keys.

Storefront API Keys Screen Breakdown

Channel Selector (Dropdown at the Top)

• Select the channel from this dropdown.

• The API key will be created only for the selected channel.

• Each Channel can have its own API key.

Generate Key Button

Generate Key

• Click the Generate Key button to create a new API key for the selected channel.

• The key will then appear in the list below.

API Key

• Shows the unique API key generated for the selected channel.

• This key is required to authenticate Storefront API requests.

• A copy icon is available to easily copy the key.

Expiry Date

• Shows the expiry date if a validity period is set.

• If blank, the key has no expiry.

Is Active

Shows whether the API key is currently active.

• When the key is active, it can be used for Storefront API access.

• The key can be paused at any time. When paused, it becomes inactive and cannot be used.

Action

Provides control options for managing the API key:

• Delete – Permanently removes the API key from the system.

• Once deleted, the same key cannot be restored.

Important Notes

• API keys must be kept confidential
• Only active keys can be used
• Delete or deactivate a key if it is no longer required
• Always select the correct channel before generating a key