External Connections
Last updated
Last updated
CERRIX enables secure, controlled sharing of control test information and evidence through the External Connections module. This feature is especially useful for auditors or third parties who require direct access to relevant control data and documentation.
Navigate to the Administration Controls menu.
Click on External Connections.
Click on Add.
Fill in the following fields:
Name
Enter a name for the external connection.
Description (optional)
Provide a brief description of the external connection.
Assurance Employee (optional)
Select the person responsible for the external connection.
Click Next
Provide the following details:
Expiration Date
Specify the date until which the API can be accessed (maximum: 1 year from today).
IP Restriction
Enter the IP address from which the API can be accessed. Only API requests from these IP addresses will be accepted.
Click Next
Select the controls that can be queried through the API.
Click Next
From the dropdown menu, select Effectiveness under Testplan type.
Specify the Start Date and End Date for the testplans from the controls that may be queried through the API.
Click Next
Click Complete
Your API key and secret are now displayed on the screen. Ensure you store them securely, as they won't be shown again.
Use your new API credentials to export control data. You can use any API tool (e.g., Postman) or your terminal. In the example below, we will use Postman.
Steps to Set Up ControlTestInformation:
Open Postman: Start the Postman application on your computer.
Create a New Request:
Click on the '+' icon or 'Create a request' to create a new request tab.
Set the HTTP Method:
From the dropdown menu next to the URL input bar, select the POST method.
Enter the URL:
Input the Base URL followed by the Routing path.
The Base URL is always composed of the environment URL followed by "/api,"
Fill in the URL as:
https://<your-environment>.cerrix.com/api/thirdpartyassurance/requestexport
Add the following query Params:
controlids
Enter the control ID in format “00000001”.
Add multiple controls by adding a semicolon ";" between the control IDs
testplantypes
Enter “Effectiveness”
testplanperiodstart
Enter the Start Date from the Period in format “2022-01-01”
testplanperiodend
Enter the End Date from the Period in format “2022-12-31”
Set up the Authorization.
Select the “Basic Auth” type.
Fill in the API key and secret as provided in the earlier step.
Press "Send"
A Request ID will be retrieved from the API call. Save this Request ID.
Create a New Request:
Click on the '+' icon or 'Create a request' to create a new request tab.
Set the HTTP Method:
From the dropdown menu next to the URL input bar, select the GET method.
Enter the URL:
Input the Base URL followed by the Routing path.
The Base URL is always composed of the environment URL followed by "/api,"
Fill in the URL as:
https://<your-environment>.cerrix.com/api/thirdpartyassurance/getresults/<requestId>
Fill in the 'requestId' field with the Request ID received through the previous API call.
Set up the Authorization.
Select the “Basic Auth” type.
Fill in the API key and secret as provided in the earlier step.
Press "Send"
The API will respond with a JSON file.
Here's a sample response containing all information related to the control:
Create a New Request:
Click on the '+' icon or 'Create a request' to create a new request tab.
Set the HTTP Method:
From the dropdown menu next to the URL input bar, select the GET method.
Enter the URL:
Input the Base URL followed by the Routing path.
The Base URL is always composed of the environment URL followed by "/api,"
Fill in the URL as:
https://<your-environment>.cerrix.com/api/thirdpartyassurance/getevidencedocument/<requestId>
Add the following query Params:
controlidentifier
Enter the control ID in format “00000001”
documentid
Locate the Document ID within the JSON file received with the Export Results API call. This ID can be found within the SourceDocuments, SampleDocuments, or StepDocuments sections.
Fill in the 'requestId' field with the Request ID received in the first API call.
Set up the Authorization.
Select the “Basic Auth” type.
Fill in the API key and secret as provided in the earlier step.
Press "Send"
The document will be received as a binary stream from the API.
CERRIX logs all API calls made for external connections. This ensures users always have an overview of the requested APIs and their respective timestamps. Furthermore, it provides insight into the specific controls that were requested.
Navigate to the Administration Controls menu.
Click on Third Party Assurance.
On this page you can find an overview of all Third Party Assurance connections.
For each connection, you can access a log of which controls were accessed.
For routing to Control Test Information, please use the following path:
For routing to Get Result, please use the following path:
For routing to Get Evidence Document, please use the following path:
