[IMP] accounting: update how to get api keys for silverfin integration

task 2918697

closes odoo/documentation#3426

X-original-commit: 9a0bf7bb0e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit is contained in:
Jonathan Castillo (jcs) 2023-01-26 16:48:42 +00:00
parent dd241b171d
commit 14154737d2
4 changed files with 40 additions and 13 deletions

View File

@ -5,7 +5,7 @@ Silverfin integration
`Silverfin <https://www.silverfin.com>`_ 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 <https://www.odoo.com>`_ and sign in with your
You can create Odoo external API keys either :ref:`for a single database <silverfin/api-singledb>`
(hosting: Odoo Online, On-premise, and Odoo.sh) or :ref:`for multiple databases managed by a user
<silverfin/api-multipledb>` (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 <https://www.odoo.com>`_ and sign in with your
administrator account. Next, open `your account security settings in developer mode
<https://www.odoo.com/my/security?debug=1>`_, 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

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -72,6 +72,8 @@ If you already have an Odoo server installed, you can just use its parameters.
username = "admin",
password = <insert password for your admin user (default: admin)>;
.. _api/external_api/keys:
API Keys
~~~~~~~~