Access APIs in Postman

this section outlines a step by step process of installing postman, obtaining upstart commerce apis, importing them as collections, and setting up the postman environment what is postman? postman is a tool for building and using apis with postman you can build and customize http requests, store request templates, and collaborate with others it supports various http methods, headers, parameters, and authentication methods, enabling you to simulate different scenarios setting up follow these steps to download our openapi specification (oas) files, import them into postman, and commence testing upstart commerce apis step 1 install postman to install postman, follow the installation guidelines available at the postman learning center step 2 download the openapi yaml file visit our " upstart commerce api documentation " all our service apis are listed under the "restful api documentation" section click on the service you are interested in exploring click on the "export" button at the top right corner select " bundled references " from the dropdown menu to download the open api yaml file, offering a comprehensive set of endpoints, request parameters, and examples for api functionality step 3 import the file to postman launch postman, the api development and testing tool click on "import" at the top left corner to open a modal window select or drop the previously downloaded "open api yaml file" from your local storage now, choose how do you want to import the "open api yaml file" you can opt for either a "postman collection" or "open api 3 1 " with a postman collection by selecting the radio button click on "view import settings" on the modal in the folder organization, select "tags " this ensures the creation of folders for consumer and management apis at last, click on "import" again, confirming the successful import into the postman step 4 configure environment variables to configure your environment, click on the "environments" button located in the side menu if you are setting up variables for a new environment, click on "add" to create a new environment for existing environments, add the following environment variables necessary for your upstart commerce instance if your company has a development instance already, please check with your technical lead for the corresponding values of these variables if you have not established a tenant id and site id, and you want to create a sandbox environment to explore our apis, go to this link the email generated during this sandbox setup will provide you with the necessary values for these environment variables base url configure the "baseurl" to the api host of your instance plus /v1 example https //apihost com/v1 tenant id and site id configure the environment variables, tenant id, and site id according to your company's development or sandbox environment further on, set {{tenant header field name}} and {{site header field name}} header of each request finally, "save" the environment configuration once the collection is imported and configured, you can explore the upstart commerce apis further we suggest you to browse endpoints review the collection to understand available endpoints and functionalities test requests execute sample requests to observe api responses and understand the data structure modify and experiment modify requests to suit your specific use cases and experiment with different parameters