Skip to content
WallaB.AI

Docs / WallaB Developer Platform

Quickstart

Create a key and make your first authenticated API call in under a minute.

Make your first authenticated call in under a minute. You'll need to be on the Growth plan or higher (the Developer Platform's requirement).

1. Create an API key

In your admin, go to Settings → WallaB Developer Platform (owner-only) and create a key. Give it a name you'll recognize and grant only the scopes it needs. The key is shown exactly once — copy it now; only a hash is stored, so it can never be retrieved again (you can always create another).

A key looks like wlb_ followed by 43 URL-safe characters.

Heads up

Treat a key like a password. Never commit it to source control, never put it in client-side code or a browser request, and rotate it if it may have leaked. See Authentication.

2. Make a request

Send the key as a bearer token. This lists your selling plans:

curl -sS https://wallab.ai/api/external/v1/plans \
  -H "Authorization: Bearer wlb_your_key_here"

The same call from JavaScript (server-side — never from a browser):

const res = await fetch("https://wallab.ai/api/external/v1/plans", {
  headers: { Authorization: "Bearer wlb_your_key_here" },
});
if (!res.ok) throw new Error(`WallaB API error ${res.status}`);
const { plans } = await res.json();

3. Read the response

{
  "plans": [
    {
      "id": 7,
      "name": "Monthly",
      "groupName": "Coffee Club",
      "intervalUnit": "month",
      "intervalCount": 1,
      "active": true,
      "productCount": 4,
      "pricing": { "discountType": "percentage", "discountValue": 15, "summary": "15% off" }
    }
  ]
}

That's it — you're authenticated and reading live shop data.

Next steps