Introduction

Getting started

This guide provides a quick overview of the essential API concepts and patterns needed to build your integration.

What you’ll build

An e-commerce storefront that pulls catalog, inventory, and pricing from HLC in real time.

Use case: Launch a dealer portal that stays in sync with HLC’s catalog without manual CSV imports.

Quick checklist

  1. Pick your base URL (CA or US).
  2. Generate an access token in the HLC web store.
  3. Make a first request (brands or products).

What to cache (and why)

Some endpoints change slowly and are perfect for daily caching:

  • Brands and Categories: refresh once per day
  • Products: refresh daily or on demand
  • Inventory: refresh frequently (minutes, not hours)

Use case: Keep the storefront fast while still showing accurate stock levels.

Required headers

Most endpoints accept these headers:

HeaderRequiredNotes
ApiKeyYesAccess token
languageNoen or fr
callerNameNoYour app identifier

Pick the right base URL

const baseUrl =
  region === 'CA'
    ? 'https://api.hlc.bike/ca/v3.0'
    : 'https://api.hlc.bike/us/v3.0'

Next steps

Move to Installation to set base URLs and tokens, then run Your first test to validate your first call.

Next
Installation