Tutorial: Set up your Postman environment
The system API documentation contains a set of tutorials that guide you through examples of how to send requests and review the responses. All of these tutorials assume the following base environment:
- An instance of Postman.
This tutorial walks you through the process of setting up this environment.
Tutorial steps
- Install Postman. (For more information, refer to https://www.postman.com/.)
You can test your environment by sending your first Postman request.
- Open Postman.
- Start a new request by clicking the + to the right of the Launchpad tab.
- Every request in Postman requires some form of authorization:
- Click the Authorization tab.
- For the Type drop-down list, select Basic Auth.
- In the Username field, enter aapplegate.
- In the Password field, enter gw.
- Under the Untitled Request label, make sure that GET is selected. (This is the default operation.)
- Click the Send button to the right of the request field.
Checking your work
Once a response has been received, its payload is shown in the lower portion of the Postman interface. If your environment has been set up correctly, the first few lines of the response payload are:
Troubleshooting: No response
Requests can be sent only to running applications. All of the tutorials in this documentation require that BillingCenter is running. If you send a request when the application is not running, you will see an error similar to the following:
Could not get any response
Troubleshooting: NotFoundException
Unless it is stated otherwise, all of the tutorials use basic authentication and the
aapplegate
user. If you encounter a NotFoundException
such as the following example, this could be caused by not providing correct authentication
information for this user.
"status": 404,
"errorCode": "gw.api.rest.exceptions.NotFoundException",
"userMessage": "No resource was found at path /common/v1/activities"