The CATI API

Overview

The API enables you to use CATI features

Version information

Version : v1

Contact information

Contact : CATI Team

URI scheme

BasePath : /catiapi/companies/<CompanyId>
Schemes : HTTP

Security

You must have an access key to access the API. Add the "X-Confirmit-ApiKey=<key>" HTTP header into your request to CATI REST API.

The key is generated by the Forsta LogOn SOAP web service. Additional information on using the LogOn service in available on the Forsta extranet, in the Forsta Web Services API SDK documentation.

Connections

Use the following hostnames when constructing the URL to the CATI REST API:

Site Name CATI Hostname

Euro

cati.euro.confirmit.com

US

cati.us.confirmit.com

Australia

cati.confirmit.com.au

Germany

cati.confirmit.de

Testlab

cati.testlab.firmglobal.net

Nordic

cati.nordic.confirmit.com

Permissions

To be able to call the API, the user must have the SYSTEM_API_ACCESS and SYSTEM_CATI_ADMINISTRATE permissions. If the user does not have these permissions, a 403 Forbidden error code will be returned.