WebService Core

webservice_core · OCA/web-api

    Repository
    OCA/web-api · module folder · Try on Runboat
    Module version
    1.0.1
    Category
    Uncategorized
    Folder size
    0.07 MB
    License
    AGPL-3
    Application
    No
    Auto-installable
    No
    Website
    https://github.com/OCA/web-api
    Last tracking update
    2026-09-23 17:21:01
    Authors
    Camptocamp, Odoo Community Association (OCA), Creu Blanca
    Maintainers
    Camptocamp, Odoo Community Association (OCA), Creu Blanca
    Committers
    Simone Orsi, OCA-git-bot, oca-ci
    Odoo dependencies
    odoo/odoo:
    - base
    Python dependencies
    openupgradelib, requests
    System dependencies
    None
    Required by
    webservice
    Description
    This module provides the ``webservice.backend`` model with its authentication
(public, username/password, API key) and HTTP call features (``get``/``post``/``put``).

It has no dependency on ``component`` or ``server_environment``, so it can be used
as a lightweight building block by any module needing to configure and call
an outbound webservice, without pulling in extra frameworks.

    Code Analysis ⓘ

    Views touched (3)
    XML IDNameModelTypeStatus
    webservice_backend_form_view webservice.backend.form (in webservice_core) webservice.backend form New
    webservice_backend_search_view webservice.backend.search (in webservice_core) webservice.backend search New
    webservice_backend_tree_view webservice.backend.tree (in webservice_core) webservice.backend list New
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (2)

    New fields (3)
    • company_id Many2one → res.company
      string='Company' args: 'res.company'
    • name Char
      required=True
    • url Char
      required=True
    Public methods (0)

    No public methods.

    New fields (8)
    • api_key Char
      auth_type='api_key' string='API Key'
    • api_key_header Char
      auth_type='api_key' string='API Key header'
    • auth_type Selection
      required=True selection=[('none', 'Public'), ('user_pwd', 'Username & password'), ('api_key', 'API Key')]
    • content_type Selection
      args: [('application/json', 'JSON'), ('application/xml', 'XML'), ('application/x-www-form-urlencoded', 'Form')]
    • password Char
      auth_type='user_pwd'
    • protocol Selection
      required=True args: [('http', 'HTTP Request')]
    • tech_name Char
      copy=False help='Unique name for technical purposes. Automatically generated from the name if left empty.' required=True
    • username Char
      auth_type='user_pwd'
    Public methods (7)
    • call(self, method, *args, **kwargs)
    • call_delete(self, **kwargs)
    • call_get(self, **kwargs)
    • call_post(self, **kwargs)
    • call_put(self, **kwargs)
    • create(self, vals_list)
      @api.model_create_multi
    • write(self, vals)