Generate a Postman Collection for a Data Product

Owned by Pascal Heus
Last updated: Jun 05, 2022
1 min read

Postman is the industry standard software and platform for developing and documenting APIs.

RDS has the ability to generate data product level Postman Collection JSON, which can be imported into any workspace for publication and sharing. This significantly enhance the API documentation by providing dataset specific descriptive and examples.

To produce this, call the api/postman/<catalog_id>/<product_id> endpoint with the following two parameters that are used to generate the HTML links in the Postman documentation:

  • dsBaseUrl: the base URL to the RDS server. For example dbBaseUrl=https://publicrichdataservicec.com/rds

  • rdsExplorerUrl: the base URL path to the data product page under the RDS Explorer. For example https://public.richdataservices.com/rds-explorer/ca/pumf_lfs

Note that this is a management feature, so you will need to be authenticated in order to be able to call this endpoint.