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.
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.
Follow these steps to download our OpenAPI Specification (OAS) files, import them into Postman, and commence testing UpStart Commerce APIs.
To install Postman, follow the installation guidelines available at the Postman Learning Center.
- 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.
- 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.
- 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 and 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.