Introduction

On the Field Effect MDR Portal’s Account Settings page (Sign in & Security tab), you can create and manage (rename, disable/enable, and delete) API keys associated with your MDR Portal account. These keys are used to authenticate our Swagger API Interface. 

Before you can access our Swagger API interface, your public IP address must be whitelisted. To get added to the whitelist, please reach out to Field Effect support at support@fieldeffect.com with your public IP address to request access. 

Once whitelisted, the documents can be accessed via the following link: https://services.fieldeffect.net/apidocs

But to access our API documentation, each user needs to be authenticated using their own unique API key. This ensures secure access to the data and functions available with the API. When making any API call, be sure to include your API key in the authorization process. 

This article walks through the process of creating an API key and authenticating the Swagger AIP interface. 

Create an API Key

API keys are generated from the Field Effect MDR Portal's Account Settings page. From the Account Settings' Sign in & Security tab, click Create API Key in the API Keys card. 

The Create API window will open. Give your API key a memorable name and click Create.

You will then be presented with the API key. As described on the window, you will only be presented with the full API key at this time. Be sure to copy and store it securely, as you will not be able to refer to it again via the MDR Portal.   

Managing API Keys

After you have created an API key, the following management options are available: 

• Edit (pencil icon): change the key's display name
• Delete (trash icon): remove the API from your organization
• Deactivate (toggle switch): disables the key's functionality but keeps it within associated with your account for future use.

Authenticating the API Swagger

Before you can access our Swagger API interface, your public IP address must be whitelisted. To get added to the whitelist, please reach out to Field Effect support at support@fieldeffect.com with your public IP address to request access.

Once you have your API Key from the MDR Portal, navigate to the Swagger API Interface and click on the Authorize button.

The Authorization window will open. In the api_key (apiKey) section, type the word "Bearer" followed by a space and your API key, as shown below. 

When added, click Authorize. 

You can now close the Authorization window and start using the API.