Home > API Usage > Postman Collection

Postman Collection

A Postman collection has been compiled to make it easier to send requests to the API for testing purposes.
You can download and import the collection into the Postman application.

Download

Postman Collection

Click the link, and then the download button at the top right of the page that opens.
In Postman, open the File menu and then click import.

What does it contain

There are 4 requests available in the collection, one per bundle type on the Examples page.
The example request bodies are already set up for you, but you may need to change a few things such as practitioner emails, patient identifiers and/or encounter period.start dates.

Environment Variables

The collection uses environment variables for CLIENT_ID, CLIENT_SECRET and BASE_URL.
You will need to set up an environment containing these variables before authenticating or sending a bundle.

The CLIENT_ID and CLIENT_SECRET are the same as those referred to in Authentication.
The BASE_URL should be https://sandbox.frbresearch.org for accessing the sandbox API or https://frbresearch.org for the live API.

For more information about Postman Environments, refer to this info page.

Authentication

Once you have your client id and client secret, create environment variables for each and generate a token from the authorization tab. Postman handles most of the authentication steps for you.
For further information, see the Authentication page.