Klu Docs

Postman and OpenAPI

Import the Public API into Postman or generate clients from the OpenAPI document.

The Public API publishes an OpenAPI document:

GET https://api.klupos.com/public-api/v1/openapi.json

The same contract is checked into the repository for developers:

docs/api/public-openapi.json

Postman

The repository includes Postman import files:

docs/api/public-api.postman_collection.json
docs/api/public-api.local.postman_environment.json

To test locally:

  1. Import both files into Postman.
  2. Select the Klu POS Public API - Local environment.
  3. Set baseUrl to http://localhost:8000/public-api/v1.
  4. Set apiKey to the owner-generated klu_live_... key.
  5. Run Me first, then Stores, then endpoint-specific requests.

For staging or production, change only baseUrl and apiKey.

OpenAPI clients

For generated clients, use the live OpenAPI document as the source of truth. The human docs explain behavior and examples, but the OpenAPI document is the contract that machines should parse.

Safe testing

  • Use a real key only in a private Postman environment.
  • Do not export an environment containing a real key.
  • Do not paste a real key into screenshots.
  • Rotate the key if it is accidentally shared.

On this page

PostmanOpenAPI clientsSafe testingRelated