[IMP] developer/api/external_api: new JSON-2 API

Author: Julien00859

content/administration/odoo_online.rst

@@ -160,49 +160,20 @@ Web Services
 ============
 
 In order to programmatically retrieve the list of the databases displayed in the
-`database manager <https://www.odoo.com/my/databases>`_, call the method `list` of the model
-`odoo.database` via a :doc:`Web Service </developer/howtos/web_services>` call.
+`database manager <https://www.odoo.com/my/databases>`_, call the method ``list`` of the model
+``odoo.database`` via a :doc:`/developer/reference/external_json2_api` call.
 
-Inspired from the examples provided in the :doc:`Web Services </developer/howtos/web_services>`
-section, this is how to retrieve this list with the library ``xmlrpc.client``::
+Example::
 
-   import xmlrpc.client
+   import requests
 
-   USER = '[email protected]'
-   APIKEY = 'your_apikey'
+   APIKEY = "your_apikey"
 
-   root = 'https://www.odoo.com/xmlrpc/'
-   uid = xmlrpc.client.ServerProxy(root + 'common').login('openerp', USER, APIKEY)
-   sock = xmlrpc.client.ServerProxy(root + 'object')
-   databases_list = sock.execute('openerp', uid, APIKEY, 'odoo.database', 'list')
-
-And here is the equivalent example with JSON-RPC::
-
-   import json
-   import random
-   import urllib.request
-
-   USER = '[email protected]'
-   APIKEY = 'your_apikey'
-
-   def json_rpc(url, method, params):
-       data = {
-           'jsonrpc': '2.0',
-           'method': method,
-           'params': params,
-           'id': random.randint(0, 1000000000),
+   requests.post(
+       "https://www.odoo.com/json/2/odoo.database/list",
+       headers={
+           "Authorization": f"bearer {APIKEY}",
+           "X-Odoo-Database": "openerp",
        }
-       req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={
-           "Content-Type": "application/json",
-       })
-       reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8'))
-       if reply.get('error'):
-           raise Exception(reply['error'])
-       return reply['result']
-
-   def call(url, service, method, *args):
-       return json_rpc(url, 'call', {'service': service, 'method': method, 'args': args})
-
-   url = 'https://www.odoo.com/jsonrpc'
-   uid = call(url, 'common', 'login', 'openerp', USER, APIKEY)
-   databases_list = call(url, 'object', 'execute', 'openerp', uid, APIKEY, 'odoo.database', 'list')
+       json={},
+   )

content/developer/howtos.rst

@@ -14,7 +14,6 @@ How-to guides
    howtos/frontend_owl_components
    howtos/website_themes
 
-   howtos/web_services
    howtos/company
    howtos/create_reports
    howtos/accounting_localization
@@ -69,11 +68,6 @@ Server-side development
 
 .. cards::
 
-   .. card:: Web services
-      :target: howtos/web_services
-
-      Learn more about Odoo's web services.
-
    .. card:: Multi-company guidelines
       :target: howtos/company
 

content/developer/howtos/web_services.rst

@@ -17,4 +17,5 @@ Reference
    reference/cli
    reference/upgrades
    reference/external_api
+   reference/external_json2_api
    reference/extract_api

content/developer/reference.rst

@@ -1,25 +1,27 @@
-============
-External API
-============
+================
+External RPC API
+================
+
+.. danger::
+
+   .. deprecated:: 19.0
+
+   Both the XML-RPC and JSON-RPC APIs are scheduled for removal in Odoo 20.0 (fall 2026). The
+   :doc:`external_json2_api` acts as replacement.
 
 Odoo is usually extended internally via modules, but many of its features and
 all of its data are also available from the outside for external analysis or
 integration with various tools. Part of the :ref:`reference/orm/model` API is
 easily available over XML-RPC_ and accessible from a variety of languages.
 
-.. important::
-   Starting with PHP8, the XML-RPC extension may not be available by default.
-   Check out the `manual <https://www.php.net/manual/en/xmlrpc.installation.php>`_
-   for the installation steps.
-
-.. note::
-   Access to data via the external API is only available on *Custom* Odoo pricing plans. Access to
-   the external API is not available on *One App Free* or *Standard* plans. For more information
-   visit the `Odoo pricing page <https://www.odoo.com/pricing-plan>`_ or reach out to your Customer
-   Success Manager.
+Starting with PHP8, the XML-RPC extension may not be available by default.
+Check out the `manual <https://www.php.net/manual/en/xmlrpc.installation.php>`_
+for the installation steps.
 
-.. seealso::
-   - :doc:`Tutorial on web services <../howtos/web_services>`
+Access to data via the external API is only available on *Custom* Odoo pricing plans. Access to
+the external API is not available on *One App Free* or *Standard* plans. For more information
+visit the `Odoo pricing page <https://www.odoo.com/pricing-plan>`_ or reach out to your Customer
+Success Manager.
 
 Connection
 ==========