All courses

The public API in 5 minutes

You create a key with only the permissions it needs, see every call your system makes with it and revoke it when it's no longer used. The full documentation is in the developer portal.

Video transcript

In this video, you'll see how your ERP, your store or your own code read and write your catalog through the public API.

Everything is in the developer portal: a REST API with a single base URL that speaks JSON.

Every call carries your key in the Authorization header, as a Bearer token.

The quickstart takes you from zero to a generated description, with examples in curl, Python and JavaScript.

You create the key in API keys, one per system, with only the permissions it needs: here, reading the catalog and reading and writing attributes.

It's shown only once, and here it's blurred: keep it in a secrets manager, never in a chat.

With that key, our test system read the drill's attributes and wrote its color. “See calls” shows every call made on a product.

For a write, you see what your system sent and what Bruxel answered. For a read, only who called, the route and the code.

Every operation is in the reference, with its parameters, its schema and sample responses, like the one that writes an attribute.

When a system no longer uses it, or if it's lost, you revoke it and it stops working instantly.

That wraps up the “Integrations” series. The full documentation is in the developer portal.

The guides in this use case

  1. 01Video · 1:14Account securityPassword, two-step verification, sessions, the organization's audit log and API keys.
  2. 02Video · 1:38WebhooksHow to notify your store or ERP when something changes in Bruxel, without anyone having to check.