InsuredAuditDeveloper Portal

Postman & Insomnia Collections

Both collections are auto-generated from docs/api/openapi.yaml on every release. If you spot a divergence, the spec is canonical — re-import the latest collection.

Download

Postman quick setup

  1. File → Import → drop in postman-collection.json.
  2. Open the collection’s Variables tab and set baseUrl (default https://api.insuredaudit.com) and apiKey. The collection sends the key as Authorization: Bearer {{apiKey}}on every request.
  3. Pick a request — start with POST /v1/events — and click Send.

Insomnia quick setup

  1. Insomnia → Application → Preferences → Data → Import Data → From File. Pick insomnia-collection.json.
  2. Pick an environment, then edit it to set baseUrl and apiKey.

Regenerating

Both files are produced from docs/api/openapi.yaml by the openapi-to-postmanv2 tooling under scripts/generate-postman.mjs. CI runs the script and checks the JSON output against the committed copy, so a contributor who edits the spec will get a failure until they re-run the generator locally and commit both files together.