Postman is a tool for testing and executing API requests. We provide an UP42 API Postman collection that contains all the endpoints you need to interact with our platform. This guide will show you how to use it and start making requests.
Run in PostmanA fork is a copy of a collection in your own workspace where you can make changes.
- Click the following link: Run in Postman.
- Click Fork Collection to create a copy of the collection.
- Select the workspace you want to copy it to and click Fork collection.
Note that to fork a collection, your Postman profile will need to be made public so that global environments are enabled.
Environment configuration is only available in forked versions of the collection.
- In Postman, open the forked collection.
- On the left, go to Environments → UP42 API Environment.
- In the variables table, set Current value:
- Set
up42_username
to your email address. - Set
up42_password
to your password.
- Set
- On the top-right, click Save.
- On the top-right, set the environment to UP42 API Environment. This will make the environment active.
After you’ve configured and set the environment, you don’t need to authenticate or manually set authorization values for any endpoint in the collection.
- Select an endpoint you want to test.
- Fill in the request parameters and click Send.
- Review the response to see the results.
If you encounter any issues, check the respective API tutorials or contact support.