Welcome to the PostmanClient SDK documentation. This guide will help you get started with integrating and using the PostmanClient SDK in your project.
- API version:
1.0 - SDK version:
1.0.0
The Postman API enables you to programmatically access data stored in your Postman account. For more information on the API, rate limiting, authentication, and policies click visit Postman's Documentation
This SDK is compatible with the following versions: TypeScript >= 4.8.4
To get started with the SDK, we recommend installing using npm:
npm install postman_clientThe PostmanClient API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.
When you initialize the SDK, you can set the API key as follows:
const sdk = new PostmanClient({ apiKey: 'YOUR_API_KEY' });If you need to set or update the API key after initializing the SDK, you can use:
const sdk = new PostmanClient();
sdk.apiKey = 'YOUR_API_KEY';You can set a custom timeout for the SDK's HTTP requests as follows:
const postmanClient = new PostmanClient({ timeout: 10000 });The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.