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: Python >= 3.7
To get started with the SDK, we recommend installing using pip:
pip 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:
PostmanClient(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER",
timeout=10000
)If you need to set or update the API key after initializing the SDK, you can use:
sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")You can set a custom timeout for the SDK's HTTP requests as follows:
from postman_client import PostmanClient
sdk = PostmanClient(timeout=10000)Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
from postman_client import PostmanClient, Environment
sdk = PostmanClient(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER",
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.billing.get_accounts()
print(result)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:
Union types allow you to specify that a variable can have more than one type. This is particularly useful when a function can accept multiple types of inputs. The Union type hint is used for this purpose.
You can call service method with an instance of TypeA, TypeB, or a dictionary that can be converted to an instance of either type.
# Model Definition
ParamType = Union[TypeA, TypeB]
# Service Method
def service_method(param: ParamType):
...
## Usage
type_a = TypeA(key="value")
type_b = TypeB(key="value")
sdk.service.service_method(type_a)
sdk.service.service_method(type_b)
sdk.service.service_method({"key": "value"})You cannot create an instance of a Union type itself. Instead, pass an instance of one of the types in the Union, or a dictionary that can be converted to one of those types.
This SDK is licensed under the MIT License.
See the LICENSE file for more details.