Getting Started

Welcome to the WebbiOS Developer Platform! WebbiOS is an Open System designed for modern commerce. By leveraging the power of Cloudflare Workers and our extensive ecosystem, you can build incredibly fast and reliable custom apps, storefront themes, and private integrations.

Prerequisites

Before diving in, ensure you have the following installed:

• Node.js: v20 or higher
• pnpm: We use pnpm as our package manager
• Cloudflare Account: To deploy your workers and pages

The WebbiOS SDK

Our core SDK @webbi/sdk provides a seamless interface to interact with the WebbiOS REST APIs. It is fully typed and handles authentication, token refreshes, and standard HTTP requests for you.

# Install the SDK using pnpm
pnpm add @webbi/sdk

Quick Initialization

Initialize the SDK by providing your API endpoint and an optional authentication token:

import { WebbiSDK } from '@webbi/sdk';

const sdk = new WebbiSDK({
  endpoint: 'https://api.yourstore.com/v1/admin',
  token: 'YOUR_ACCESS_TOKEN'
});

// Fetch products
const products = await sdk.products.list();
console.log(products);

Exploring the Reference

Check out the autogenerated SDK Reference to see all available methods, classes, and properties.