Postman collection
Download a ready-to-run Postman collection, optionally prefilled with your API key, clinic id and client id.
The collection has every request on this site: health, the create-task
variants, eligibility-result, task-status, and a folder of
test IDs you can run without touching a real patient.
Fill in any of the three values below to have them written into the collection's variables, or leave them blank and set them in Postman after importing.
A prefilled file contains your key
If you enter your API key, the downloaded file holds it in plain text. Treat the file like the key itself: do not commit it, attach it to a ticket, or share it outside your team. To hand the collection to someone else, download it with the fields blank.
Importing it
- In Postman, choose Import and drop in the downloaded file.
- Open the collection, then Variables. Check
apiKey,clinicIdandclientId. Enter the key without theBearerprefix; the collection adds it. - Run Test IDs > 990-01: eligible, wait 30 seconds, then run Results > Get eligibility result.
How authentication is set up
There is no token request in the collection because there is no token
exchange: the key is long-lived and sent on every call. The collection's
Authorization tab sends x-api-key: Bearer {{apiKey}} on every request,
and each request carries X-Clinic-ID and X-Client-ID from the variables.
See Authentication.
If your gateway or API manager ignores collection-level authorization when
importing, add x-api-key: Bearer {{apiKey}} as a header on each request
instead.
The task id carries over
Each create-task request saves the returned task_id into the taskId
variable, so the requests under Results poll the task you just created
without copying anything by hand.