QBitFlow
Get started

SDKs

The official clients for the API. Every code example in these docs comes from their tested examples.

The SDKs

Each of the four SDKs (TypeScript, Python, Go and PHP) installs in one line and speaks the v2 API.

Create a client

Every example assumes a client named client ($client in PHP), built once from QBITFLOW_API_KEY.

Create a client

client-init.sh

# Every request sends your API key. The start-up check: what is this key, and which mode is it in?curl https://api.qbitflow.app/v2/me \  -H "X-API-Key: $QBITFLOW_API_KEY"# 200: { "credential": "apiKey", "role": "admin", "space": { "test": true, … }, … }

client-setup.ts

Source : qbitflow-js-sdk · examples/client-setup.ts (opens in a new tab)
// One client per API key, shared by the whole program. A blank key, one not starting with// sk_, or one with a space or a control character, throws a ValidationError (nothing is sent).const client = new QBitFlow(process.env.QBITFLOW_API_KEY ?? ''); // The recommended start-up check: what is this key, and which mode is it in? An// AuthenticationError for an unknown or revoked key.const me = await client.me();console.log(`${me.role} key, test mode: ${me.space?.test}`);

client_setup.py

Source : qbitflow-python-sdk · examples/client_setup.py (opens in a new tab)
# One client per API key, shared by the whole program. ValidationError: not an sk_… key.client = qbitflow.QBitFlow(os.environ["QBITFLOW_API_KEY"]) # The recommended start-up check: what is this key, and which mode is it in?me = client.me()  # AuthenticationError for an unknown or revoked keyif me.space is not None:    print(f"{me.space.organization_name}, role {me.role}, test mode {me.space.test}")

client/main.go

Source : qbitflow-go-sdk · examples/client/main.go (opens in a new tab)
// One client per API key, shared by the whole program: it is safe for concurrent use.client, err := qbitflow.NewClient(os.Getenv("QBITFLOW_API_KEY"))if err != nil {	log.Fatal(err) // a *qbitflow.ValidationError: no key, or not an sk_… key} // The recommended start-up check: what is this key, and which mode is it in?me, err := client.Me(ctx)if err != nil {	log.Fatal(err) // a *qbitflow.AuthenticationError for an unknown or revoked key}if me.Space != nil {	fmt.Printf("%s, role %s, test mode %v\n", me.Space.OrganizationName, me.Role, me.Space.Test)}

client-setup.php

Source : qbitflow-php-sdk · examples/client-setup.php (opens in a new tab)
// One client per API key, shared by the whole application.$client = new \QBitFlow\QBitFlow(apiKey: (string) getenv('QBITFLOW_API_KEY')); // The recommended start-up check: which space and mode is this key in?$me = $client->me(); // an AuthenticationException for an unknown or revoked keyprintf("%s, role %s, %s mode\n", $me->space?->organizationName ?? '?', $me->role ?? '?', $me->space?->test ? 'test' : 'live');

The client does the API's chores for you:

  • Safe retries: an Idempotency-Key on every create, retried for you (idempotency).
  • Lists walked: paginated lists iterate page by page (pagination).
  • Webhooks verified: signatures checked locally, with no call (verify a signature).
  • Typed errors: each carries the code and the requestId (errors).

Moving from 2.x

The 3.x SDKs speak the v2 API. Each repository's migration guide (above) lists what changed, method by method; the API reference has the shapes.

WooCommerce

QBitFlow for WooCommerce takes crypto payments in a store, with no code: what it does on WooCommerce, and how to install and test it in the WooCommerce how-to.