On the APIs page, administrators can create and manage APIs for use in Report Gateway reports. A set of parameter APIs is included with the system reports supplied by MRI. Report and system administrators must also add any additional new APIs from which Report Gateway will be reading report parameters.
The APIs page shows a grid of all APIs available in your instance of Report Gateway, with information organized in the following columns:
▪ Name—The name of the API.
▪ Platform type—The platform type of the API.
▪ Data source—The source of the data used by the API. This source can either be a Platform API or a Static list.
▪ Parameter-enabled—If this column contains a check mark, this API can be used as an option for a report parameter, packet parameter, or batch iteration list.
▪ Custom—If this column contains a check mark, this API was created by a Report Gateway user at your organization.
Note
The MRI WebDesign product license is required to create new API lookup lists for client-specific reports. The MRI Information Exchange (MIX) is not required when used for this specific purpose.
Users can start typing or select an option from the search fields at the top of the screen to filter results of each column. Custom (non-MRI) APIs are listed before MRI APIs.
To add a new API, follow these steps:
1. Go to Admin Settings > APIs.
2. Click Add. The Add an API page appears.
3. In the Name field, enter a name for the API that is unique for this platform type and client ID.
4. In the API name field, enter the name of this API. For platform APIs, the API name will be used as the API ID when making requests from the platform.
5. In the Platform type field, enter the platform type for this API.
6. Select the Parameter API check box if this API should be usable as an option for a report parameter, packet parameter, or batch iteration list.
7. In the Data source field, select whether to use a platform API or a static list as the source of data for the API.
▪ If you selected Platform API, the Query string parameters field appears. Enter the query string for the API, using brackets { } to pass parameters to the API.
▪ If you selected Static list, the Values field appears. Enter each value for the API on a separate line in the Values field.
8. Click Save. You are returned to the APIs page.
Note
If this API uses a platform type of PropertyManagement, you must also add the API to MRI.
To edit an API, follow these steps:
1. Go to Admin Settings > APIs.
2. Click the name of the API that you want to edit. The Manage API page appears.
Note
You cannot edit the system APIs provided with Report Gateway.
3. Click in the field to be updated and change the necessary information.
4. Click Save. You are returned to the APIs page.
You can use the Test API feature to validate an API to ensure it has been configured correctly. You can test an API either before or after you add it. The Test API feature returns the first five results of the API based on the current Report Gateway context (i.e. the Client ID, username, and database). If no database is selected, you are prompted to choose one.
To test an API, follow these steps:
1. Go to Admin Settings > APIs.
2. Click Test API. The Test API page appears.
3. In the API Name field, enter the name of the API to test.
4. In the Get Request field, enter the parameter value to use for the GET request for this API test.
5. Click Test. The top five results appear in the result window.
6. When you are finished, click Cancel to return to the APIs page.
To delete an API, follow these steps:
Note
Deleting an API will remove it from all reports where it is used.
1. Go to Admin Settings > APIs.
2. In the row of the API you want to delete, click Delete.
Note
You cannot delete the system APIs provided with Report Gateway.
3. Click OK to confirm the deletion.