Testing Rover Connect in Postman

Postman is an application that can be used to make requests to API services. This useful in testing API functionality. Follow the steps below to begin testing Rover Connect with Postman.

1. Postman can be downloaded from the following link: https://www.getpostman.com/.

2. Once downloaded, open Postman and look for the request builder.

3. Under the Builder tab, the request builder lets you create any kind of HTTP request quickly. The four parts of an HTTP request are the URL, method, headers, and the body. Postman gives you tools to work with each of these parts.

Let's begin to build an example request targeted at the /hotels Configuration API.

5. First we will need to get a valid access token. To do this click on the "Authorization" tab and select "OAuth 2.0" from the dropdown. Then click "Get New Access Token"

• For the token name, choose anything so that you can identify the token. (e.g. "Client Credentials Token")
• For the "Auth URL" enter one of the two following URLs:
  • For development: https://auth-dev.stayntouch.com/oauth/authorize
  • For production: https://auth.stayntouch.com/oauth/authorize
• For the "Access Token URL" enter one of the following URLs:
  • For development: https://auth-dev.stayntouch.com/oauth/token
  • For production: https://auth.stayntouch.com/oauth/token
• For the "Client ID" enter the Client ID received from the Developer Portal or Engineering Team.
• For the "Client Secret" enter the Client Secret received from the Developer Portal or Engineering Team.
• Leave "Scope" blank
• Each issued "Client ID" is configured for the Client Credentials or Authorization Code Grant Type method. Choose the one applicable to you.
• Click "Request Token"
• The newly created token will show up under "Existing Tokens"
• Select the newly created token and click "Use Token"

6. Now you will need to add the API-Version in the Header of the of the request.

• Under the "Headers" tab click "New Key" and enter "API-Version"
• In the corresponding "Value" column enter "1.0"
• Make sure this is checked.

7. Because the /hotels API is a GET request make sure the HTTP protocol dropdown is set to GET.

8. Enter the request URL.

9. Enter any url parameters manually into the URL or you can use the "Params" area.

• Click "Params"
• Enter in key-value pairs in the same fashion as done in the Headers tab.

10. Click "Send" and the response will be returned in JSON format.

If the request uses the POST protocol you can add key-value pairs to the "Body" tab after you have selected "POST" from the HTTP Protocol dropdown. You do not want to complete Step 9 for any POST requests.