Setup & Prerequisites

1. Creating an API Project

To communicate with the Foxentry REST API, you need a dedicated project in your Foxentry dashboard.

1. Log in to your account at app.foxentry.com. (New accounts include a 14-day free trial).
2. Click on New Project.
3. Important: Select Application / API as the project type (do not select Web form / JS).
4. Name your project (e.g., "Data Cleaner Integration") and complete the setup wizard.

2. Generating the API Key

Once your project is ready, you need to generate the actual authentication key.

1. Go to the Settings of your newly created API project.
2. Navigate to the API Keys tab.
3. Click the empty card labeled Create API Key.
4. In the sidebar, give your key a recognizable name (e.g., "Local Data Cleaner").
5. Click Create new key.

⚠️

Save Your Key Immediately

For security reasons, Foxentry displays the full API key only once immediately after creation. Later, you will only see a masked version in the dashboard. Copy the key and store it securely or paste it directly into the Data Cleaner. If you lose it, you will need to generate a new one.

3. Security Best Practices

Since the Data Cleaner runs locally, it's highly recommended to apply additional security layers to your API key directly within the Foxentry dashboard:

• IP Whitelisting: In the key settings, restrict the usage of this API key to the specific IP address (or IP range) of the machine running the Data Cleaner. This ensures that even if the key is leaked, it cannot be used from outside your network.
• Expiration Date: If you are running a one-off database cleanup, set an expiration date for the key so it automatically invalidates after your work is done.

4. First Run & Windows SmartScreen

The Data Cleaner is a standalone executable and requires no installation. However, if you are running the .exe file on Windows for the first time, you might encounter a blue Microsoft Defender SmartScreen warning.

This is standard Windows behavior for newly released binaries. It takes time for the SmartScreen filter to build a global reputation based on the number of downloads.

How to bypass it safely:

1. On the blue screen, click More info.
2. Verify that the publisher is listed as AVANTRO s.r.o. (our official company name).
3. Click the Run anyway button.

Once executed, the application will automatically spin up a local server and open the visual interface in your default web browser.

Next step: Now that your environment is ready, let's explore how to upload your file and map your data in the Supported Validations & Mapping Logic section.