Installation/Configuration

Install the Base ERP NF-e Issuer Plugin for WooCommerce and connect your store to the correct environment using an API key.

When you complete this step, go on to product registration and linking before starting the NF-e issuance flow.

📘

Important

Installing and configuring the plugin is only the first step of the process.

For the NF-e issuance flow to work correctly, you will also need to register the products in Base ERP and link them to the corresponding products in WooCommerce.

Before you start

Confirm that:

  • your Asaas account is a legal entity (company) account;
  • Base ERP is activated for the account;
  • you have access to Base ERP;
  • your store uses WooCommerce;
  • you have administrative access to WordPress.

Use at least:

RequirementVersion
WordPress6.2 or higher
PHP7.4 or higher
WooCommerce8.2 or higher

Also define which environment will be used:

EnvironmentWhen to use
SandboxTesting and validation before real NF-e issuance.
ProductionReal invoice issuance.
🚧

Attention

Each environment has its own API key.

The key generated in the Sandbox must be used only in the Sandbox environment. The key generated in Production must be used only in the Production environment.

Configuration flow

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
A["Install the plugin"] --> B["Define the environment"]
B --> C["Generate the API Key in Base ERP"]
C --> D["Configure the key in WooCommerce"]
D --> E["Validate the configuration"]
E --> F["Register products in Base ERP"]
F --> G["Link products in WooCommerce"]

classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

class A inicio
class B,C,D,E,F validacao
class G sucesso

linkStyle default stroke:#94A3B8,stroke-width:2px

1. Install the plugin

The recommended way is to use the official WordPress page:

Base ERP – Invoices for WooCommerce plugin

In the WordPress dashboard:

  1. Go to Plugins > Add New.
  2. Search for Base ERP for WooCommerce.
  3. Click Install Now.
  4. After installation, click Activate.

Manual installation

If you need to install manually:

  1. Download the .zip file from the plugin's official WordPress page.
  2. Go to Plugins > Add Plugin.
  3. Click Upload Plugin.
  4. Select the .zip file.
  5. Click Install Now.
  6. After installation, click Activate Plugin.

When you finish, the Base ERP tab should be available in WooCommerce > Settings.

2. Generate the API Key in Base ERP

The key must be created in the same environment that will be used by the plugin.

If you do not yet have access to Base ERP, see Asaas account in Base ERP.

In Base ERP:

  1. Go to User menu > Settings > API Keys.
  2. Create a new key.
  3. Set a name that identifies the integration, such as Emissor NF WooCommerce.
  4. Copy the generated key before leaving the screen.

Also see the Base ERP Authentication documentation.

❗️

Responsibilities for your API key

  • The Base ERP API key follows the non-recoverable key model, meaning it will be displayed only once when created.
  • Copy and save the key in a safe place before leaving the integrations area.
  • Never store API keys in plain text in source code or in publicly accessible configuration files.
  • If you lose your key, it cannot be recovered. You will need to generate a new key and replace the previous one.
  • Each environment, Production and Sandbox, has its own unique API key.
  • Generate the key in the same environment that will be selected in the plugin settings.

3. Connect WooCommerce to Base ERP

In WordPress:

  1. Go to WooCommerce > Settings.
  2. Open the Base ERP tab.
  3. Select Sandbox or Production.
  4. Enter the corresponding key in the API Key field.
  5. Save the settings.
📘

Best practice

Before using Production, configure the plugin in the Sandbox and validate the complete installation, connection, product registration, and linking flow.

Expected result

The configuration should be saved without an authentication error and remain associated with the selected environment.

If the connection fails, confirm:

  • that the API Key was copied in full;
  • that the key is still active;
  • that the key belongs to the selected environment;
  • that the plugin is installed and active.

4. Prepare the products

Connecting to Base ERP does not complete the integration.

🚧

Attention

Configuring the API Key does not replace product registration and linking.

Products without a correct link between WooCommerce and Base ERP may not be identified in the NF-e issuance process.

Before issuing NF-e:

  • register the products in Base ERP;
  • fill in the required tax information;
  • find the Internal Identifier of each product;
  • link this identifier to the corresponding product in WooCommerce.

This step is detailed in Product Registration/Linking.

When switching environments

Always switch the environment and API Key together.

A Sandbox key used in Production, or a Production key used in the Sandbox, prevents correct authentication.

After changing the environment, validate the connection again before issuing anything.

Next steps


Did this page help you?