Skip to main content

Authorization

Follow this guide to create a new Odoo ERP credential that will allow Nexla to authenticate to and exchange data with your Odoo instance.
odoo_erp_cred_api_auth.png

Odoo ERP

Prerequisites​

To connect Nexla to your Odoo instance, you will need the following information from your Odoo deployment and user account.

Odoo Instance Details​

You will need your Odoo Server URL and Database Name before creating a credential in Nexla.

  • Server URL: This is the domain of your Odoo instance (e.g., https://mycompany.odoo.com for Odoo Online, or your self-hosted URL such as https://erp.example.com). You can find this in your browser's address bar when logged into Odoo.

  • Database Name: For Odoo Online accounts, the database name is typically the subdomain of your instance URL (e.g., mycompany for https://mycompany.odoo.com). For self-hosted Odoo, the database name can be found in Settings > Technical > Database Structure or by contacting your Odoo administrator.

User Account with API Access​

You will need an Odoo user account with sufficient permissions to access the data models you wish to integrate. The user must have at minimum read access to the Odoo models (database tables) that you plan to use as data sources, and write access for any models you intend to use as destinations.

Authentication Credential: Password or API Key​

Odoo supports two methods for authenticating external API connections: using a standard account password, or using a dedicated API key (available in Odoo 14 and later). Using an API key is the recommended approach for integrations because it can be revoked or regenerated independently without changing your main account password.

To generate an API key for use with Nexla, follow these steps in your Odoo instance:

  1. Log in to your Odoo account.

  2. Click on your profile icon (your name or avatar) in the top-right corner of the screen to open the user menu.

  3. Select Preferences from the dropdown menu.

  4. In the Preferences screen, click on the Account Security tab.

  5. Scroll down to the API Keys section and click the New API Key button.

  6. Enter your account password when prompted to confirm your identity, then click Confirm Password.

  7. Enter a clear, descriptive name for the key in the Key Description field (e.g., "Nexla Integration"). This description is the only way to identify the key later, so choose a name that clearly indicates its purpose.

  8. Click Generate Key.

  9. Copy the generated API key immediately and store it in a secure location such as a password manager. Odoo will not display this key again after you close the dialog.

The API key provides the same level of access as your account password for API operations. Treat it with the same care as your password. If the key is compromised, you can revoke it from the Account Security tab without affecting your main account credentials or other API keys.

Create an Odoo ERP Credential​

  • To create a new Odoo ERP credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Connection Settings​

  1. Enter the URL of your Odoo instance in the Odoo Server URL field. This should be the complete base URL including the protocol (e.g., https://mycompany.odoo.com). Do not include a trailing slash or any path segments.

  2. Enter the name of your Odoo database in the Odoo Database Name field. For Odoo Online accounts, this is typically the subdomain of your instance URL (e.g., mycompany). For self-hosted deployments, enter the database name configured during setup.

  3. Enter the login email address associated with your Odoo user account in the Username field.

  4. Enter your account password or API key in the Password field. Using an API key is recommended for integrations—see the Prerequisites section above for instructions on generating an API key.

Nexla authenticates with Odoo using the XML-RPC API over HTTPS. Ensure that your Odoo instance is accessible from the internet and that external API access has not been disabled in your Odoo configuration. For self-hosted deployments, verify that your server's firewall allows HTTPS traffic from Nexla's IP ranges.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.