Installation/Configuration

This page presents the installation and configuration process of the NF-e Issuer Plugin for WooCommerce from Base ERP.

After installed and configured, the plugin connects your WooCommerce store to Base ERP through an API key, allowing you to start the NF-e issuance flow for orders of products sold in the store, as long as the products are correctly registered and linked between the systems.

When to use

Use this page when you need to:

install the NF-e Issuer Plugin for WooCommerce;
configure the connection between WooCommerce and Base ERP;
define whether the integration will use Sandbox or Production;
generate and inform the Base ERP API key;
validate whether the connection was saved correctly;
prepare the store for product linking and NF-e issuance.

📘
Important
Plugin installation and configuration are only the first step of the process.
For the NF-e issuance flow to work correctly, it will also be necessary to register the products in Base ERP and link them to the corresponding products in WooCommerce.

Before starting

Before installing and configuring the plugin, check whether:

your store uses WooCommerce;
you have administrative access to WordPress;
your Asaas account is a legal entity account;
Base ERP is activated for the account;
you have access to Base ERP;
you have defined whether you will run tests in Sandbox or real issuance in Production;
you have or will generate a Base ERP API key in the correct environment.

🚧
Attention
Each environment has its own API key.
The key generated in Sandbox must be used only in the Sandbox environment. The key generated in Production must be used only in the Production environment.

Plugin installation

You can install the NF-e Issuer Plugin for WooCommerce through the official WordPress store or by manual installation.

Official WordPress store

Download and install the plugin through the official WordPress store:

NF-e Issuer Plugin for WooCommerce

This is the recommended installation method, as it allows you to use the standard WordPress plugin installation flow.

Download and manual installation

If you prefer to install manually, follow the steps below:

Download the .zip file by clicking here.
Access the administrative panel of your WordPress store.
Go to the Plugins > Add Plugin menu.
At the top of the screen, click Upload Plugin.
In the displayed modal, click Choose file.
Select the .zip file downloaded in step 1.
Click Install Now.
Once installation is complete, click Activate Plugin.

After activation, the NF-e Issuer Plugin will be installed in your store. The next step is to configure the connection with Base ERP.

Plugin configuration

With the plugin installed and activated, proceed to configure the connection with Base ERP.

To do this, you must have previously accessed Base ERP and generated your API key, which will be responsible for connecting your WooCommerce store to the NF-e issuer.

It will also be necessary to define the connection environment:

Environment	When to use
Sandbox	For tests, simulations, and flow validation before real NF-e issuance.
Production	For real invoice issuance. Use only after validating the configuration.

Information about access to Base ERP and its respective environments can be consulted in the official Base ERP documentation.

Generating the API key in Base ERP

After defining the connection environment, generate the API key in Base ERP corresponding to the environment that will be used.

Follow the steps below:

Access your Asaas account in the chosen environment: Sandbox or Production.
After logging in, click the applications icon, located in the upper-right corner of the Asaas account, near the notification bell.
Access Base ERP.

For more details about activation and access, consult the documentation about Asaas account in Base ERP.
Inside Base ERP, go to Settings > API Keys.
Create a new key.
To make identification easier, you can name it NF WooCommerce Issuer or another name related to your operation.
After generation, copy the key and store it in a secure location.

❗️
Responsibilities with your API key

The Base ERP API key follows the unrecoverable key model, meaning it will be displayed only once when created.

Copy and save the key in a secure location before leaving the integrations area.

Never store API keys in plain text inside source code or configuration files accessible to the public.

If you lose your key, it will not be possible to recover it. You will need to generate a new key and replace the previous one.

Each environment, Production and Sandbox, has a unique and exclusive API key.

Generate the key in the same environment that will be selected in the plugin settings.

Informing the key in WooCommerce

With the key generated and safely stored, inform it in the plugin inside WordPress.

Follow the steps below:

Access the administrative panel of your WordPress store.
Go to WooCommerce > Settings.
In the top tabs, click Base ERP.
Select the connection environment: Sandbox or Production.
Paste the API key in the API Key field.
Save the settings.

If everything goes as expected, a message will be displayed informing that the settings were saved successfully.

Important settings

During configuration, pay attention to the following fields:

Setting	Description
Environment	Defines whether the plugin will connect to Sandbox or Production in Base ERP.
API Key	Key responsible for authenticating the connection between WooCommerce and Base ERP.
Base ERP tab in WooCommerce	Location where the plugin connection is configured.
Linked products	Necessary step after configuration to allow NF-e issuance.

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

How the plugin acts after configuration

After the plugin is installed and connected to Base ERP, your store will be prepared to start the NF-e issuance process for orders of products sold in WooCommerce.

However, issuance depends on complementary steps, such as:

registration of products in Base ERP;
filling in the necessary tax information;
link between the WooCommerce product and the corresponding product in Base ERP;
validation of the configured environment;
checking the orders that will be used in the issuance flow.

🚧
Attention
API Key configuration 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.

Impacts of changing the environment

Switching between Sandbox and Production must be done carefully.

Change	Impact
Sandbox to Production	Starts using the connection intended for real NF-e issuance.
Production to Sandbox	Starts using the test and simulation environment.
API Key from incorrect environment	May prevent the connection between WooCommerce and Base ERP.
Incorrect environment selected	May generate authentication failures or send data to the wrong environment.

Before changing the environment, confirm whether the informed API key belongs to the selected environment.

Operational impacts

Incorrect configuration can directly impact the store’s tax and operational flow.

Some possible impacts include:

failure in the connection between WooCommerce and Base ERP;
impossibility of starting the NF-e issuance flow;
sending data to the incorrect environment;
use of an invalid or incompatible API key;
products sold without a link to Base ERP;
need to generate a new API key in case of loss;
delay in invoice issuance;
divergences between WooCommerce orders and records in Base ERP.

Therefore, validate the connection and product link before starting real issuance in Production.

Common errors and questions

Situation	Possible cause	How to act
Base ERP tab does not appear in WooCommerce	Plugin not installed or not activated	Check whether the plugin was installed and activated correctly
Configuration is not saved	Required field not filled in or temporary WordPress error	Review the fields and try saving again
Plugin does not connect to Base ERP	Invalid, missing API Key, or API Key from the incorrect environment	Generate a new key in the correct environment and update the plugin
API Key lost	The key is displayed only once	Generate a new key in Base ERP and replace the previous one
Incorrect environment	Production selected with Sandbox key, or the opposite	Confirm the selected environment and the origin of the key
NF-e is not issued after configuring the plugin	Products not yet registered or not linked to Base ERP	Follow the product registration and linking step

Best practices

For a safer configuration, it is recommended to:

install the plugin through the official WordPress store whenever possible;
test the flow in Sandbox before using Production;
generate the API key in the correct environment;
save the API key in a secure location;
not store the key in public files or source code;
review the selected environment before saving the configuration;
validate whether the success message was displayed after saving;
register and link the products before starting the issuance flow;
periodically review the plugin configuration;
maintain internal control of generated and replaced keys.

Next step

After installing and configuring the plugin, the next step is to perform the product registration and linking.

This step is necessary so that Base ERP can correctly identify the products sold in WooCommerce and use the information in the NF-e issuance process.

Install the plugin
↓
Configure environment and API Key
↓
Register products in Base ERP
↓
Link products in WooCommerce
↓
Validate NF-e issuance flow