Postman is a tool used for API development, testing, and exploration. You can use Postman to test and explore the TSM API.
Complete the following steps to get started with Postman and the TSM API:
Install Postman as a browser extension or desktop app.
To authenticate to the TSM API, you need a way to store and manage cookies. You can install Postman Interceptor to do this automatically from within Postman.
Download the Postman collection from the Samples page.
Extract the contents of the samples.zip
file.
Open Postman.
Click Import.
Select the tsm_api.postman_collection.json
file that you downloaded as part of the samples.
Click the gear icon in the upper-right and click Manage environments.
The TSM API collection uses an environment to store data like the server address, the API version, credentials, and more.
Click Add to create a new environment.
Create a name for your environment and set the following keys:
server
. The address or IP address of the computer running TSM. (Do not add https://
.)version
. The API version. (The current version is 0.5.)port
. The TSM port number. (If you’re not sure, the default is 8850.)user
. The username of a user with access to TSM.password
. The password of a user with access to TSM.Click Add to save the enviroment.
Click the Collections tab and open the TSM collection.
Select the environment you created from the list in the upper-right. The default is No Enviroment.
Select the Login > POST Login endpoint in the TSM collection.
Click Send.
A successful login returns a 204 status code. The Cookies tab displays an AUTH_COOKIE
that is stored by Postman for additional requests.
Continue exploring the API!