Getting started

1. Install

bash

bashCopy

1npm install @aiminaabeejs/js-sdk @aiminaabeejs/types

2. Create the client

Use a publishable key for browser/mobile clients. Never ship a secret API key to the storefront.

tsCopy

1import Aiminaabee from "@aiminaabeejs/js-sdk"
2
3const sdk = new Aiminaabee({
4  baseUrl: "https://api.aiminaabee.com",
5  publishableKey: process.env.NEXT_PUBLIC_PUBLISHABLE_KEY,
6  auth: {
7    type: "jwt",
8    jwtTokenStorageMethod: "local",
9  },
10})

3. Auth modes

Use JWT mode (default) for SPAs that store a bearer token client-side. Use session mode when the API exchanges the token for an HTTP-only cookie — set fetchCredentials: "include" when the API is on another origin.

tsCopy

1import Aiminaabee from "@aiminaabeejs/js-sdk"
2
3const sdk = new Aiminaabee({
4  baseUrl: "https://api.aiminaabee.com",
5  publishableKey: process.env.NEXT_PUBLIC_PUBLISHABLE_KEY,
6  fetchCredentials: "include",
7  auth: {
8    type: "session",
9  },
10})

4. List products

GET /store/:storeCode/products

First Store API call via the SDK.

tsCopy

1const { products, count } = await sdk.store.product.list("us", {
2  limit: 20,
3  offset: 0,
4})
5console.log(products, count)

For a full walkthrough of listing products, carts, checkout, and customer accounts, see Storefront Development. For React Native and Expo, see Mobile Development.