Developer onboarding

Build and Test with the BSimple API

Use a BSimple free trial as your API development environment: create an account, generate a key, build against real data and move to production when ready.

requestv1
$ GET /api/v1/inventory/list
scoped access · JSON response

Build and Test with the BSimple API

You do not need to wait for a sales call or build against an imaginary schema. Start a BSimple free trial, create a test account, generate an API key and build your integration against the data and workflows available in that account.

The developer path

01

Start a free account

Create a BSimple trial for the business or workflow you want to connect. No credit card is required to get started.

02

Create a scoped key

Inside BSimple, open Settings → API Keys. Name the integration, select the smallest useful scopes and copy the secret when it is shown.

03

Build and test

Use the getting-started guide and API reference to read data, create draft invoices and test your error handling.

04

Move to production

When your workflow is proven, create a separate production key, review scopes and move your application to the live account and environment.

What the free trial is for

The trial gives a developer a real BSimple account to explore the API contract instead of relying only on sample payloads. You can test the requests your integration needs, inspect the returned JSON, confirm scope failures and build the application-side pagination and reconciliation behavior before a production rollout.

The API exposes the capabilities available to the account. If a workflow depends on a paid BSimple feature, plan or integration, that feature remains subject to the relevant subscription or configuration; the API does not bypass those product boundaries.

A safe way to test

Start read-only. A sensible first pass is:

  1. Create a trial account and one API key.
  2. Grant inventory:read or another single read scope.
  3. Make a request from a server-side application.
  4. Add only the next scope required by the workflow.
  5. Test invalid keys, insufficient scopes, missing records and validation failures.
  6. Keep test and production keys separate.

Do not put the API key in browser JavaScript or commit it to a repository. The customer portal guide explains how to keep the key behind your own server.

Start building

Your first environment

Start with a real account.
Build something useful.

When you are ready, take the free trial through the normal BSimple signup flow.

Start the free trial

If you need to confirm a paid feature, account configuration or production rollout, contact BSimple with the workflow and scopes you expect to use.

Ready when you are

Build it against
a real account.

Build with a free trial