Limio
WebsiteHelp Desk
  • Home
  • Custom Components
    • Getting Started with Custom Components
    • Connecting External CI
    • Development Guidelines
    • Prop Types
    • Custom subcomponents
    • Connecting to External Service
  • Limio SDK
    • Getting Started with Limio SDK
    • Basket (Cart), Promo Code
    • Page, Offer, and Add-On
    • User, Subscription, Invoice & Address
    • Advanced Methods
      • Express Checkout
      • Core Utilities and Helpers
  • API Docs
    • Authentication Schemes
      • OAuth Bearer Token
      • API Key (Catalog API-only)
    • Catalog API
    • Promo Codes API
    • Order API
    • Objects API
    • Shop Build & Publish API
    • External Identities API
  • Webhooks
    • Using Webhooks
    • Webhooks Overview
  • I want to...
    • Retrieve abandoned baskets
    • Enable self-service on a CPQ order
Powered by GitBook
On this page
  • API Key Generation
  • Sending Requests
  • Deleting Keys

Was this helpful?

  1. API Docs
  2. Authentication Schemes

API Key (Catalog API-only)

The API key authentication method gives access to the Catalog API and is read-only. You can use it to retrieve information about a Page.

PreviousOAuth Bearer TokenNextCatalog API

Last updated 3 months ago

Was this helpful?

Most API actions such as sending Orders, retrieving Subscriptions, adding Identities, or retrieving Abandoned Baskets require the authentication method.

API Key Generation

To get an API key, log-in to your Limio account, go to Profile > Developers > Limio Keys and hit the 'Generate New' button. This will create a new key linked to your Limio environment.

Sending Requests

Now you have an API key, you can start to read data required by your website or application from the Catalog API.

You will need to use the key in the header with every request to our API. Below is an example fetch to retrieve some offers:

fetch('/api/example', {
    headers: {Authorization: "YOUR_API_KEY_HERE"}
}).then(res => res.json())

Deleting Keys

If you wish to delete an existing key, this can be done by selecting the 'Delete' button next to the key you wish to delete in the developer area of the catalog.

Please be aware that this cannot be undone and will require you to update any references to this key that are currently being used with a new API key.

Each Limio account is currently limited to 2 public API keys. If what you are building requires more, please contact .

support@limio.com
Catalog API
OAuth Bearer Token