Postman collection

A ready-to-use Postman collection covering the full Billerang v1 API surface.

Downloads

File	Contents
Billerang v1 APIs	Full v1 surface (69 tag folders generated from the OpenAPI spec) plus a Query API folder with live-verified examples — 534 requests
Billerang v1 Environment	Environment variables for local development

The collection is regenerated directly from the published OpenAPI spec (openapi-v1.yaml, 315 paths, 522 operations), grouped by OpenAPI tag, so it always matches the current spec. See Query API for the grammar behind the Query API folder's examples.

Import instructions

1. Open Postman
2. Click Import
3. Import both the collection and the environment JSON files
4. Select "Billerang v1 - Local Development" environment in the top-right dropdown
5. Run any request — authentication is automatic (see below)

Auto-authentication

The collection includes a pre-request script that obtains and refreshes the Bearer token before every request using the client_credentials grant. You never need to fetch a token manually.

Environment variables

Variable	Description	Default (local dev)
base_url	API base URL	http://localhost:8080
keycloak_url	Keycloak server URL	http://localhost:8081
realm	Keycloak realm	billerang
client_id	OAuth client ID	billerang-backend
client_secret	OAuth client secret	(set from your local .credentials file)
access_token	Bearer token, auto-populated by the pre-request script	—
token_expiry	Unix timestamp the pre-request script uses to know when to refresh	—

Collection structure

The collection has 71 top-level folders:

• 00 - Authentication — one request, gets a bearer token via the client_credentials grant.
• Query API (live-verified examples) — 11 requests: the filter, nested $operator, aggregation, forceCount, SQL, count, and metadata examples captured live in Query API, plus one POST-dialect example.
• 69 tag folders, one per OpenAPI tag on the v1 spec (Sellers, Charges, Products, Offer Templates, Orders, Subscriptions (v1), Query, and so on), each containing every operation the spec defines for that tag — 522 requests total, matching the 522 operations in the spec.

Request bodies are generated from each operation's request schema (required fields first, then a handful more, capped to keep bodies readable). Treat them as a realistic starting shape to fill in, not literal values to send unedited. Path parameters ({code}, {id}, and so on) come through as Postman path variables you set before running a request.