Quickstart

1Register as a developer

Go to admin.bazex.co and create an account. When registering, select the Developer role. This gives you access to the developer portal where you can create and manage apps.

2Create your first app

Navigate to My Apps in the developer portal and click Create App. Fill in the basics:

• Name — your app's display name
• Slug — URL-safe identifier (immutable after creation)
• Redirect URL — where merchants are sent after OAuth approval
• Scopes — what data your app needs access to

After creation, you'll receive a Client ID and Client Secret. Store the secret securely — it's only shown once.

3Test install on your sandbox

Every developer account gets a sandbox business for testing. On your app's detail page, click Test Install. This installs the app on your sandbox and gives you an access token (fbat_...) without going through OAuth.

4Make your first API call

Use the access token to call the App API. Here's how to fetch products:

curl -X GET https://api.bazex.co/app-api/products \
  -H "Authorization: Bearer fbat_your_access_token" \
  -H "Content-Type: application/json"

const res = await fetch('https://api.bazex.co/app-api/products', {
  headers: {
    'Authorization': 'Bearer fbat_your_access_token',
    'Content-Type': 'application/json',
  },
});

const { data, total, page, limit } = await res.json();
console.log(`Found ${total} products`);

The response includes paginated product data scoped to the merchant's business.

5Set up webhooks

Register a webhook to receive real-time notifications when events happen on the merchant's store:

curl -X POST https://api.bazex.co/webhooks \
  -H "Authorization: Bearer fbat_your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/bazex",
    "events": ["order.created", "product.updated"]
  }'

The response includes a secret (format: whsec_...) for verifying webhook signatures. See the Webhooks guide for details.

6Submit for review

When your app is ready, click Submit for Review in the developer portal. The Bazex team will review your app and approve or provide feedback. Once approved, your app appears in the public marketplace.

See the full App Lifecycle guide for details on the review process, versioning, and scope expansion.