diff --git a/content/applications/finance/accounting/reporting/silverfin.rst b/content/applications/finance/accounting/reporting/silverfin.rst index 325037da0..2ebc85158 100644 --- a/content/applications/finance/accounting/reporting/silverfin.rst +++ b/content/applications/finance/accounting/reporting/silverfin.rst @@ -5,7 +5,7 @@ Silverfin integration `Silverfin `_ is a third-party service provider that offers a cloud platform for accountants. -Odoo and Silverfin provide an integration to automate the synchronisation of data. +Odoo and Silverfin provide an integration to automate the synchronization of data. Configuration ============= @@ -22,20 +22,45 @@ To configure this integration, you need to input the following data into your Si Odoo API key ------------ -To create a new API key, navigate to `Odoo's website `_ and sign in with your +You can create Odoo external API keys either :ref:`for a single database ` +(hosting: Odoo Online, On-premise, and Odoo.sh) or :ref:`for multiple databases managed by a user +` (hosting: Odoo Online). + +.. important:: + - These API keys are personal and provide full access to your user account. Store it securely. + - You can copy the API key only at its creation, and you cannot retrieve it later. + - If you need it again, create a new API key (and delete the old one). + +.. seealso:: + :doc:`/developer/api/external_api` + +.. _silverfin/api-singledb: + +One key per database +~~~~~~~~~~~~~~~~~~~~ + +To create a new API key valid for a single database, click on the user menu, then on +:guilabel:`My Profile`. Under the :guilabel:`Account Security` tab, click on :guilabel:`New API +key`, confirm your password, give a descriptive name to your new key, and copy the new API key. + +.. image:: silverfin/api-key-db.png + :align: center + :alt: creation of an Odoo external API key for a database + +.. seealso:: + :ref:`api/external_api/keys` + +.. _silverfin/api-multipledb: + +One key for multiple databases (fiduciaries) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a new API key valid for all the databases of a single user **(the easiest for +fiduciaries)**, navigate to `Odoo's website `_ and sign in with your administrator account. Next, open `your account security settings in developer mode `_, click on :guilabel:`New API Key`, confirm your password, give a descriptive name to your new key, and copy the new API key. -.. important:: - - You can copy the API key only at its creation, and you cannot retrieve it later. - - The API key provides full access to your user account. Store it securely. - - If you need it again, create a new API key. - - You can delete your existing API keys from this same page. - -.. image:: silverfin/api-key.png +.. image:: silverfin/api-key-user.png :align: center - :alt: creation of an Odoo external API key for an integration with Silverfin - -.. seealso:: - :doc:`/developer/api/external_api` + :alt: creation of an Odoo external API key for an Odoo user diff --git a/content/applications/finance/accounting/reporting/silverfin/api-key-db.png b/content/applications/finance/accounting/reporting/silverfin/api-key-db.png new file mode 100644 index 000000000..c8568f78a Binary files /dev/null and b/content/applications/finance/accounting/reporting/silverfin/api-key-db.png differ diff --git a/content/applications/finance/accounting/reporting/silverfin/api-key.png b/content/applications/finance/accounting/reporting/silverfin/api-key-user.png similarity index 100% rename from content/applications/finance/accounting/reporting/silverfin/api-key.png rename to content/applications/finance/accounting/reporting/silverfin/api-key-user.png diff --git a/content/developer/api/external_api.rst b/content/developer/api/external_api.rst index 53e544d37..93355536f 100644 --- a/content/developer/api/external_api.rst +++ b/content/developer/api/external_api.rst @@ -72,6 +72,8 @@ If you already have an Odoo server installed, you can just use its parameters. username = "admin", password = ; +.. _api/external_api/keys: + API Keys ~~~~~~~~