Skip to content
English
Sign in
  • There are no suggestions because the search field is empty.

How do I connect Corfix to Acumatica using an API key instead of a login?

This article will summarize the two authentication options available in Corfix Preferences inside Acumatica, why API Key is now the recommended option, and the steps to switch if you are currently using Login (Legacy).

 Before you start

You will need:

  • Access to Corfix Preferences in your Acumatica instance (found under the Corfix customization package). Only available once the Corfix license and integration package have been installed within your acumatica environement.
  • Permission in your Corfix account to create and manage API keys.

Important: An API key works like a password. Copy it as soon as you create it, store it somewhere secure, and do not share it in email or chat. Do not delete the key from your Corfix account once it is in use, as this will immediately stop the connection between Corfix and Acumatica.

Overview and explanation

The Corfix Preferences screen in Acumatica is where you tell Acumatica how to identify itself to Corfix. Think of it as the handshake between the two systems.

There are two ways to make that handshake:

Option What it uses Who sees it
Login (Legacy) A specific Corfix username and password, plus your Company Corfix ID Customers who set up the integration using an older customization package
API Key A single key you generate inside your Corfix account The recommended option for everyone.

The Login (Legacy) method ties your integration to one person's Corfix login. If that person changes their password, has their access removed, or leaves the company, the connection stops working. The API Key method removes that dependency. The key belongs to your company, not to an individual, and it does not expire when someone changes a password.

If you are already using Login (Legacy)

If your integration was set up with an older customization package, your Authentication field will now display Login (Legacy). Your connection will keep working, but we recommend switching to API Key at your convenience.

To switch:

  1. Log in to your Corfix account and generate a new API key. Name it Acumatica so it is easy to identify later. Full steps are here: Create and manage API keys
  2. Copy the key and keep it handy. You will not be able to view it again after you close the window.
  3. In Acumatica, open Corfix Preferences and select the GENERAL tab.
  4. In the Authentication dropdown, change Login (Legacy) to API Key.
  5. The username, password, and Company Corfix ID fields will be replaced by a single API Key field. Paste your key into it.
  6. Click TEST CONNECTION to confirm Corfix and Acumatica are talking to each other.
  7. Click Save.

Your existing entity selections and parameters (Project, Employees, Forms, Project Notes, Cost Codes, and your Entities Parameters mappings) are not affected by this change. Only the way Acumatica identifies itself is changing.

If you are a newer customer

If you are setting up the integration for the first time, API Key is already the option you should be using. You will not need a dedicated Corfix login for the integration, and you will not need to know your Company Corfix ID.

  1. In Corfix, generate an API key and name it Acumatica. See Create and manage API keys.
  2. Copy the key.
  3. In Acumatica, open Corfix Preferences.
  4. Set Authentication to API Key and paste your key into the API Key field. This is all that is required in the AUTHENTICATION section.
  5. Select the entities you want to sync under ENTITIES, and complete the required fields under ENTITIES PARAMETERS.
  6. Click TEST CONNECTION, then Click Save.
Use cases and benefits
  • Staff changes do not break your sync. The key is not tied to one employee's login, so onboarding and offboarding no longer put your integration at risk.
  • Password policies stay out of the way. If your team is required to rotate passwords regularly, your connection is no longer affected.
  • Nothing to look up. No Company Corfix ID and no dedicated integration login to track down or document.
  • Access is easy to revoke. If you ever need to cut the connection, delete or deactivate the key in Corfix. No password resets required.
  • Clear naming keeps things tidy. Naming the key Acumatica makes it obvious what it is for if you later add other connections.
Behaviour changes: what's new?
Login (Legacy) API Key
What you enter Username, password, and Company Corfix ID One API key
Where it comes from An existing Corfix user account Generated in your Corfix account
Breaks on password change Yes No
Breaks when a user is removed Yes No
Recommended No, kept for existing setups Yes

If you have questions about switching, or the TEST CONNECTION check does not succeed, contact your Corfix Support and we will help you get connected.