Postman API Resource Center

This is a toolbox for working with Postman. It provides a wealth of resources for working with the platform as a developer, allowing you to put the platform to work as part of your applications, integrations, and API orchestrations.

This is just a proof of concept at this moment, and the collections are still being developed!

APIs for the Postman Platform

APIs
Tne API for managing the APIs you have published to the Postman platform.
Resources: APIs
Documentation Run in Postman
Collections
Tne API for managing the collections you have published to the Postman platform.
Resources: APIs, Collections
Documentation Run in Postman
Environments
Tne API for managing the environments you have published to the Postman platform.
Resources: APIs, Environments
Documentation Run in Postman
Import
Tne API for importing APIs and collection into the Postman platform.
Resources: APIs, Imports
Documentation Run in Postman
Mocks
Tne API for managing the mock servers you have published to the Postman platform.
Resources: APIs, Mocks
Documentation Run in Postman
Monitors
Tne API for managing the monitors you have running on the Postman platform.
Resources: APIs, Monitors
Documentation Run in Postman
Workspaces
Tne API for managing the workspaces you have running on the Postman platform.
Resources: APIs, Workspaces
Documentation Run in Postman
Users
Tne API for managing the users on your team within the Postman platform.
Resources: APIs, Users
Documentation Run in Postman
Echo
Postman Echo is service you can use to test your REST clients and make sample API calls. It provides endpoints for GET, POST, PUT, various auth mechanisms and other utility endpoints.
Resources: APIs, Echo
Documentation Run in Postman


Authoriztion and Rate Limiting

You need a valid API Key obtained under your user settings within the dashboard to send requests to the API endpoints--all API endpoints are subject to rate limiting.

Visit Dashboard to Get Key

Open Source Postman Tooling

Postman Collection SDK
Postman Collection SDK is a NodeJS module that allows a developer to work with Postman Collections. Using this module a developer can create collections, manipulate them and then export them in a format that the Postman Apps and Postman CLI Runtimes (such as Newman) can consume.
Resources: Collections, SDK, Platform
Newman
Newman is a command-line collection runner for Postman. It allows you to effortlessly run and test a Postman collection directly from the command-line. It is built with extensibility in mind so that you can easily integrate it with your continuous integration servers and build systems.
Resources: Collections, Testing, Automation, Pipelines, Platform
Postman Code Generator
This module converts a Postman SDK Request Object into a code snippet of chosen language.
Resources: Client Code, Gemerators, Platform
Postman Runtime
This is a low-level library used as the backbone for all Collection running & Request sending functionality, in the Postman App, and allied systems (Postman Monitoring, Newman). If you are looking to execute collections, you should be using Newman, this is very low level.
Resources: Runtime, Platform
Chai Postman
Chai plugin to assert on Postman Collections.
Resources: Assertions, Testing, Platform
Postman URL Encoder
Postman URL Encoder is a NodeJS module that provides various URL encoding related APIs. This module is created to implement the WHATWG URL specification to remove dependency on Node's URL APIs across Postman systems. These APIs are useful to encode different parts (like hostname, path, query) of URL and convert PostmanUrl object into Node's Url like object.
Resources: URLs, Encoder, Platform


Postman Schema

The Postman schema provides the structure of the underlying resources being made available the Postman platform.

View the Postman Schema

Open Specifications Postman Has Adopted

OpenAPI
Postman leverages the OpenAPI specification as the contract for each API being delivered or consumed, providing a single definition for each API being delivered and put to work in applications and integrations.
Resources: OpenAPI, Specifications, HTTP 1.1
Visit Website
JSON Schema
Postman uses JSON Schema to validate JSON objects as part of the API lifecycle, and the request and response for each API being delivered or consumed, as well as part of each OpenAPI contract being managed.
Resources: Schema, Specifications, JSON Schema, Validation
Visit Website
RAML
Postman leverages the RAML specification as the contract for each API being delivered or consumed, providing a single definition for each API being delivered and put to work in applications and integrations.
Resources: RAML, Specifications, Modeling
Visit Website
GraphQL
Postman leverages the GraphQL specification as the contract for each API being delivered or consumed, providing a single definition for each API being delivered and put to work in applications and integrations.
Resources: GraphQL, Specifications, Queries
Visit Website


Postman is a Member of the OpenAPI Initiative (OAI)



Open Source Tools for Working with API Specifications

OpenAPI to Postman Collection Converter
A library for converting OpenAPI 3 definitions to version 2 of the Postman collection format.
Resources: OpenAPI v3, Postman Collection v2, Conversion, Definitions
Swagger v1 to Postman Collection Converter
A library for converting Swagger v1 definitions to version 2 of the Postman collection format.
Resources: Swagger v1, Postman Collection v2, Conversion, Definitions
Swagger v2 to Postman Collection Converter
A library for converting Swagger v2 definitions to version 2 of the Postman collection format.
Resources: Swagger v2, Postman Collection v2, Conversion, Definitions
GraphQL to Postman
A library for converting GraphQL schema to version 2 of the Postman collection format.
Resources: Swagger v2, Postman Collection v2, Conversion, Definitions
RAML v2 to Postman
A library for converting RAML v2 schema to version 2 of the Postman collection format.
Resources: RAML v2, Postman Collection v2, Conversion, Definitions
RAML v1 to Postman
A library for converting RAML v1 schema to version 2 of the Postman collection format.
Resources: RAML v1, Postman Collection v2, Conversion, Definitions
CURL to Postman
A library for converting cURL commands to version 2 of the Postman collection format.
Resources: RAML v1, Postman Collection v2, Conversion, Definitions


Learning Center

Find everything you need to learn about Postman, and how you can produce and consume APIs using the platform, with documentation that is kept up to date with each release coming from the Postman enginueering team.

Visit the Learning Center

Quick Reference

Reference documentation providing helpful ways of working with Postmn, providing a cheatsheet, dynamic variables, request creation, assertions, schma validation, JavaScript libraries, workflows, and how to work with Newman.

Visit the Quick Reference

Community

Find questions and answers from the community, providing useful information on how to work with Postman. Providing a forum for the community to find what they while producing and consuming APIs using the Postman platform.

Visit the Quick Reference

App Support

Postman has a repo dedicated to supporting the application, leveraging Github as a public feedback loop for bugs, features, and other ways in which the Postman platform can be improved based upon what developers need.

Visit the App Support Repo

Road Map

Postman maintains a public version of its road map using Trello, providing developers with a look at what is being planned in the near future, helping ensure there is a little more transparency for the Postman road map.

Visit the Postman Road Map

Network

The Postman Network provides a public catalog of APIs that developers can put to work, providing a place they can visit in the dessktop applicaiton and on the web to find the latest API reference collections they can use.

Visit the Postman Road Map

Templates

Postman templates from a way for developers to share simple Postman collections that help accomplish specific business objectives, helping developers better produce and consume APIs, and understand what is happening with each API.

Visit the Postman Road Map

About this Developer Toolbox

It can be difficult to keep up with all of the moving parts of the Postman platform, so we wanted to create a simple toolbox that developers could bookmark and use to help use on a regular bases, providing a single place to find everything they need to automate and work with the Postman platform.

You can view a machine readable index of this API toolbox via the projects APIs.json file.

Join the Conversation on GitHub

Stories from the Toolbox

A Single Place to Find All the Postman Developer Resources (08 Aug 2020)
It can be tough to keep up with where all of the Postman developer resources exist, so to help make it easier to stay in tune with the platform we created a dedicated Postm...
View Post