Skip to main content

Create a WebReports Connection Profile Using an API Key

Cory Fifield
Updated

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Article Goal

Learn how to create a WebReports connection profile in VDM using an API Key for users with the API role enabled. This allows secure, key-based authentication when integrating VDM with WebReports.

What Is the API Key for?

The API Key is used to authenticate your application requests to the WebReports API instead of using login credentials. This approach is ideal for:

  • Programmatic access to WebReports

  • Users with the API role

  • Scenarios where secure credential handling is critical

Important: You will only see the API Key once during creation. Make sure to store it securely for future use.

Prerequisite: Enable API Key Support in appsettings.json

In order for API Key authentication to work with VDM, the following setting must be enabled in your WebReports appsettings.json file:

 
"APISettings": { "AllowAPIKeysForVDM": "true" }
 
Tip: If your appsettings.json file does not already include the APISettings section, you’ll need to add it.
If it’s the final entry in the file, make sure not to add a trailing comma, or the JSON will become invalid.

Where Can You Create a WebReports Connection?

Connection profiles are created in VDM via the Database ribbon bar. When setting up a new profile, select the WebReports connection type and enable Use API Key.

Video Tutorial

Steps to Create a WebReports Connection Profile Using an API Key

Note: This method is not compatible with Active Directory authentication.

Step 1: Open VDM


Launch the VDM application.

Step 2: Navigate to the Database Tab


Click on the Database ribbon bar at the top.

Step 3: Create or Edit a Connection

  • Click New to create a new connection,
    OR

  • Right-click an existing WebReports connection and select Edit

Step 4: Select Connection Type


Choose the WebReports connection type from the list.

Step 5: Enable API Key Authentication


Check the box for Use API Key.

Step 6: Enter Connection Details

  • WebReports URL – The URL to your WebReports environment

  • WebReports Value – Typically the Company ID

  • Application Name – Name assigned when the API Key was created

  • API Key – The unique key shown during API creation

Step 7: Test the Connection


Click Test Connection to validate the input fields.

Tip: If the test fails, double-check the URL, API Key, and application name. Also confirm the JSON config is correct.

Step 8: Refresh and Select Connection Profile


Click Refresh List, then select the connection profile from the list.

Step 9: Save the Profile


Click Next or Finish to save. Then confirm that the connection allows you to select fields and retrieve data.

Article Summary

To connect VDM to WebReports using an API Key, you must first enable API Key usage in the appsettings.json file. Once enabled, VDM allows you to configure the connection profile using your API credentials instead of login details. This method is secure, flexible, and perfect for environments that need programmatic or limited-access integration.

Use Case: A developer needs to automate report pulling through VDM without storing usernames or passwords. An API Key connection profile offers a secure and scalable solution.

 

Related to

Related articles

Comments

0 comments

Please sign in to leave a comment.