Skip to main content
A Postman collection has been established to make testing the CBS API endpoints simple and intuitive. Symmetry serves the Postman files from the API itself rather than as static downloads, so the collection always reflects the current endpoints.

​
Download from Swagger

Both files come from the Postman endpoints, and both require authorization.

Postman endpoints in Swagger

Jump to the Postman section of the Swagger UI to execute both endpoints and save each response.
Both endpoints require your API key/postman/collection and /postman/environment are authenticated with the pcc-api-key header. Requests without a valid key return HTTP 401. See Authentication model.

​
Import into Postman

1

Authorize in Swagger and download both files

Authorize in the Swagger UI with your pcc-api-key, then execute GET /postman/collection and GET /postman/environment and save each response as a file.
2

Import both files into Postman

In Postman, select Import, then add the collection file and the environment file you downloaded.
3

Select the environment and set your credentials

Activate the environment, then supply your own apiKey.

​
Environment variables

There are two variables in the environment. * Set automatically on download. /postman/environment returns endpointURL already set for the deployment tier you download it from, so a staging download comes preconfigured for staging. The only value you need to enter by hand is apiKey.