Utilizing the Reporting API

The INFIMA Reporting API allows partners to customize the reporting method they share with their clients. The API provides high level roll up data for clients as well as detailed training and phishing results per user.

Overview

INFIMA uses API keys to allow secure access to the Reporting API.

The API key is required to be included in all API requests to the server in a header that looks like the following:

X-API-Key: YOUR_API_KEY

Warning

Do not share your API Key with anyone. Doing so could result in unauthorized access to your Security Awareness Training data.

Generating your API Key

Log in to your INFIMA Dashboard.
Select Partner Menu > Settings from the Navigation Panel.
Under Integrations, select Reporting API.
Here you will see a display of all current API Keys for your tenant. To generate a new key, select Generate API Key.
Choose a Title for a key. This should be something identifiable such as the purpose or use of the key.
Select which Scope to set for the key. Most partners will want Partner Level - All Clients which provides access to all partner data. Selecting a client limits responses to only that client's tenant.
Click Generate to generate your new API Key.

Once you have generated the key, you will not be able to view it again. Please make sure to copy it and store it in a safe place.

Utilizing the API

Detailed instructions including endpoints, object structure, and examples can be found at https://infimasec.com/developers.