Single APIs can be used when the third-party system can perform an atomic operation with a single API call. For example, if the use case is to fetch data for a Data Subject from a third-party system and that system supports fetching data using a single REST API, then Single API is the appropriate choice.
Select Single API from the Add New Rest API dropdown list to begin adding migration criteria and setting up the integration.
In the Settings tab, select whether the integration is for Request or Task(1). Then click Add Criteria(2) to add the criteria to apply on the map. Click the dropdown button on a selected criterion to add a criteria value. You can select multiple criteria as needed.
If you selected Task, select a task template from the Task template dropdown list.
Select a use case for API Usage from the list (3). Each use case can pair with any API method.
Then set the mapping (4) to Not Required if the current API call is not required, or to Required to require the API call at all times when there are updates and to record integration logs.
In the URL tab, select the HTTPS Method to use in the workflow (1).
Enter the custom API URL (2) and URL Parameters (3). To use variable keys in the URL, format them as [[${variable}]]. For example: https://www.website.com/[[${variable}]]. You can map Value Mapping attributes multiple times as necessary — at runtime, the values of the IRM attribute mapped multiple times will be passed to the receiving system's mapped attributes.
In the Params tab, enter a Key and select a Value from the dropdown list, as applicable.
Click Add Param to add more parameters or Remove All to delete all listed parameters. You can also click the Delete button on an individual parameter to remove it.
In the Headers tab, enter a Key and select a Value from the dropdown list, as applicable.
Click Add Header to add more headers or Remove All to delete all listed headers. You can also click the Delete button on an individual key to remove it.
In the Body tab, enter a Key and select a Value from the dropdown list, as applicable.
You can click {} Edit in Code to input the payload as a JSON body.
Click Add Attribute to add more attributes. You can click Remove All to delete all listed attributes or the Delete button on an individual attribute to remove it.
If you selected Verify Data in DSR Systems as the API Usage in Step 3, IRM dynamically displays the Response Mapping tab.
Click Save to save the integration setup, or click Save & Add Another API to add more APIs.
Click View Intake Form to open the intake form in another tab.
In the Publish tab of the intake form, click the Intake Form URL to review and submit the information.
Once done with verification, go to Admin > Logs to check the integration transfer logs.
Sample Successful API Call
Sample Failed API Call