Test and interact with the Provide API using Postman

Postman is a lightweight tool used to analyze and test API endpoints (click here to download). To enable you to quickly familiarize yourself with the Provide API endpoints, we have created Postman collections containing the basic routes to read and update content.


Using Postman with a hybrid instance of the Provide stack requires external applications and services that must be installed prior to initiating requests. The dependencies listed below are current as of v0.9.0 and are required on all operating systems unless otherwise noted.

Postman is a collaboration platform for API development. Postman's features simplify each step of building an API and streamline collaboration so you can create better APIs—faster. Postman can be used in a web browser or installed locally. This guide will provide instructions for using a locally installed version of Postman, though browser based instances should follow a similar pattern.

The Provide stack relies on Docker containerization to simulate a production deployment that enables core microservices in a local development environment. Find detailed instructions for installing Docker on your system see the Get Docker page. Necessary images will be downloaded at runtime and do not require manual installation. Additional information about the Docker images used, please visit the Provide Dockerhub page.

The Provide CLI is used to run a local instance of the Provide stack and exposes functions of the stack via the command line. Instructions for installing the CLI can be found here. Though the Postman collections are configured to use production services, the Baseline proxy is currently not public. We recommend following the full installation of the CLI in order to take advantage of the full stack , but only the Baseline proxy is utilized for Postman interaction.

Last updated