- Introduction
- Installing and updating
- Navigating Postman
- Sending your first request
- Managing your account
- Syncing your work
- Discovering templates
- Creating your first collection
- Creating a workspace
- Setting up your Postman app
- Importing and exporting data
- Troubleshooting app issues
- Building requests
- Authorizing requests
- Receiving responses
- Grouping requests in collections
- Using variables
- Managing environments
- Visualizing responses
- Specifying examples
- Using cookies
- Working with certificates
- Generating client code
- Troubleshooting requests
- Using the Collection Runner
- Scheduling runs with monitors
- Building request workflows
- Importing data files
- Working with your team
- Defining roles
- Requesting access
- Sharing your work
- Your Private API Network
- Commenting on collections
- Versioning APIs
- Using version control
- Using the API Builder
- Managing and sharing APIs
- Validating APIs
- Monitoring your APIs
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- Monitoring FAQs
- Analyzing with reports
- Documenting your API
- Authoring your docs
- Publishing your docs
- Viewing documentation
- Using custom domains
- Publishing templates
- Publishing to the API Network
- Submission guidelines
- Managing your team
- Purchasing Postman
- Billing
- Configuring team settings
- Utilizing audit logs
- Onboarding checklist
- Migrating data between teams
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Microsoft AD FS
- Custom SAML in Azure AD
- Custom SAML in Duo
- Custom SAML in GSuite
- Custom SAML in Okta
- Custom SAML in Onelogin
- Custom SAML in Ping Identity
- Migrating to the current version of Postman
Collection SDK
The Collection SDK is a node.js utility that allows you to work with Postman Collections and build them dynamically into your API project pipeline.
With the Collection SDK, you can create and manipulate collections, exporting them in a format that you can then integrate with other utilities including the Postman app and Newman CLI.
Accessing the Collection SDK
The Collection SDK is an open source project—visit the repo for more detail on using the module in your own projects. The SDK documentation provides an overview of the available objects and methods within the SDK, as well as an intro to the related concepts.
You can install the SDK from NPM or direct from the repo. The following excerpt demonstrates using the SDK to read a file and parse it into a collection object in JavaScript:
var fs = require('fs'),
Collection = require('postman-collection').Collection,
myCollection;
myCollection = new Collection(JSON.parse
(fs.readFileSync('sample-collection.json').toString()));
console.log(myCollection.toJSON());
The Collection SDK provides an interface for working with the data structures defined by the Postman Collection Schema. You can use the SDK methods to create and manipulate collection elements, define request detail, variables, authentication, and so on.
Next steps
Get started with the Collection SDK from the project repo, installing it and using the methods to build collections in a way that suits your development or testing project. You can also fork and contribute to the project, or create issues for any problems or feature requests.
If you're working with the Collection SDK to automate part of your collection run workflow, you can integrate your collection SDK development using the Postman CLI Newman.