Skip to main content

Test with Postman

Test API v2 with one ready-to-import Postman collection and separate Production and Local environments. OAuth settings are already configured.

Download Postman templates (.zip)

The ZIP contains a README, the Bedrijfsrooster v2 collection, and two environment templates. Use the Postman desktop app and a Connect client with a client secret. Register this exact callback URL on the client:

https://oauth.pstmn.io/v1/browser-callback

Quick start​

  1. Extract the ZIP and Import the three JSON files into a Postman workspace.
  2. Select Bedrijfsrooster Production. Enter local values for br_client_id and br_client_secret in the environment.
  3. Open Bedrijfsrooster v2 → Authorization → Get New Access Token. Complete browser sign-in and consent as a company owner, then choose Use Token. Keep Auto-refresh access token enabled.
  4. Run the Smoke Tests folder, then explore API Reference. Both folders share the collection's token automatically.
FolderWhat it does
Smoke TestsReads company configuration and timeclock badges. An empty badge list is valid.
API ReferenceIncludes the 11 supported API operations.
DiscoveryChecks public OAuth and API metadata; no authentication required.

Environments and access​

Use Production for integration testing against your live company. Local is for internal development and requires the internal network/DNS and a trusted local certificate authority. When switching environments, also select or obtain the matching OAuth token at collection level.

Writes are disabled until you deliberately set br_allow_writes=true. Keep credentials local and token sharing off. If authorization expires or is revoked, use Get New Access Token again. No manual token copying or refresh scripts are needed.

When importing an updated bundle, replace the collection and keep your populated environments. See Authentication for the underlying OAuth flow.