Generate PAR URL

• Import Postman Collections

• Set Environment Variables

• Generate Token

• Generate PAR URL

Import Postman Files

This section contains instructions for importing the preconfigured Postman collection and environment for OS into your Postman instance.

1. Navigate tohttps://github.com/oracle/hospitality-api-docs/tree/main/postman-collections/reporting-and-analytics.

2. Download the Collection file by highlighting the R&A_ObjectStorage_ParURL.postman_collection.json file in GitHub, then selecting the More Options > Download option. Save to your local machine.

3. Download the Environment file by highlighting the R&A_PARVariables.postman_environment.json file in GitHub, then selecting the More Options > Download option. Save to your local machine.

4. To import the Collection from Postman, select Collections and click the Import option.

5. Select the R&A_ObjectStorage_ParURL.postman_collection.json file from your local machine using the Postman application to import the Collection.

6. To import the Environment, from Postman, select Environments and click the Import option.

7. Select the R&A_PARVariables.postman_environment.json file from your local machine using the Postman application to import the Environment.

Set Environment Variables

This section contains instructions for defining each of the environment variables in your Postman instance.

From the Environment section of Postman, click R&A_PARVariables to expose all the required environment variables.

IDCSHostName

The IDCSHostName variable represents the URL path to your identity management host. This value will be available from your application logon page in the browser address bar.

Copy your R&A URL up to ".com" and update it to the Current column under the IDCSHostName variable.

APPId

The APPId variable will be unique to your application instance and can be found under the Controls > File Delivery > Object Storage tab in the Application Portal.

Copy the AppID value in the portal to the Current column under the APPID variable.

APPSecret

The APPSecret will also be unique to your application instance and can be found under the Controls > File Delivery > Object Storage tab in the Application Portal. Click the Show button to expose the secret.

Copy the AppSecret value in the portal to the Current column under the APPSecret variable.

TenantID

The TenantID variable will also be unique to your application instance and can be found under the User > About in the Application Portal.

Copy the TenantID value in the portal to the Current column under the TenantID variable.

Token

The Token variable can be automatically populated to the environment variables by executing the GetToken API under Collection now that the first fours environment variables have been defined.

1. From Postman, select the Collection option.

2. In the Environment list, pin the R&A_PARVariables environment.

3. From Collections, select the GetToken post command.

4. Click Send to retrieve the token and automatically populate to the current value in the Environment variables.

PortalEndPoint

The PortalEndPoint variable defines which environment you are currently attempting to utilize (Production or UAT). Use one of the following values depending upon the source of the object to populate the Current PortalEndPoint:

• PROD:https://portal.ohra.oraclehospitality.ocs.oraclecloud.com/

• UAT:https://uat.ohra.oraclehospitality.ocs.oraclecloud.com/

Prefix

The Prefix variable will depend upon the Prefix value used when generating the BIPublisher report. Use the Prefix for the report and update the Current Prefix value.

FileName

The FileName variable will depend upon the file name value used when generating the BIPublisher report. Use the FileName for the report and update the Current FileName value.

MinutesToExpire

The MinutesToExpire variable will default to 15 minutes in which the PAR URL that is generated is valid for use. Change the Current value to the number of minutes you wish to allow for the URL to be active for the end user.

Generate PAR URL

This section contains instructions for generating a PAR URL for an object.

1. From Collections, select the Generate PAR URL post command.

2. Click Send to generate the PAR URL in the response tab of Postman.

3. Copy and distribute this URL to allow access to the object.