OdooWiki OCA HUB

WebService

webservice folder_open OCA/web-api open_in_new
Sin categoría Licencia: AGPL-3

Este módulo crea frameworks de WebService para ser usados globalmente.

El módulo introduce soporte para el protocolo HTTP Request. La llamada webservice HTTP devuelve por defecto el contenido de la respuesta. Se puede pasar un contexto 'content_only' para obtener el objeto de respuesta completo.

Traducción automática al español (DeepSeek) de la descripción original de OCA, que está en inglés.

auto_awesome Qué hace este módulo

Generado por IA a partir del código · Odoo 19.0

Permite a los administradores registrar servicios web externos (endpoints HTTP) en Odoo con su URL, método de autenticación y tipo de contenido, y usarlos desde otros módulos para enviar solicitudes GET, POST o PUT.

Este módulo añade una nueva pantalla llamada WebService Backend, que se encuentra en el menú Settings, donde los administradores crean y gestionan conexiones a servicios web externos. Cada registro almacena un nombre, un nombre técnico, la URL del endpoint, el tipo de contenido esperado (JSON, XML o Form) y, opcionalmente, una compañía.

Para cada conexión se elige cómo autenticarse: - Public (sin credenciales) - Username & password - API Key, con el nombre de la cabecera a usar - OAuth2, ya sea Backend Application (client credentials) o Web Application (authorization code)

El formulario muestra solo los campos relevantes para el tipo de autenticación seleccionado y los exige, por lo que no se puede guardar una configuración incompleta. Para OAuth2 Web Application, se calcula automáticamente una URL de redirección y un botón "OAuth Authorize" inicia el flujo de autorización; después de que el proveedor redirige de vuelta, el token se almacena en la conexión y el usuario vuelve al formulario. Los tokens de OAuth2 se almacenan en caché y se renuevan automáticamente antes de que expiren.

Otros módulos pueden entonces llamar a estas conexiones para enviar peticiones GET, POST o PUT, con las credenciales y las cabeceras aplicadas automáticamente. Los valores sensibles como contraseñas, claves de API y tokens se ocultan en la interfaz, y las URLs se limpian antes de escribirse en los logs. El acceso está restringido a los administradores del sistema, y los registros se filtran por compañía para configuraciones multi-compañía.

Depende de

component

Lo necesitan otros módulos

edi_webserviceedi_webservice_ocawebservice_server_env
Modelos y campos (5)
  • base.requests · modelo nuevo
  • webservice.backend · modelo nuevourl, name, api_key (API Key), password, protocol, username, auth_type, tech_name, company_id (Company), oauth2_flow, content_type, oauth2_scope, oauth2_state, oauth2_token, redirect_url, api_key_header (API Key header), oauth2_audience (Audience), oauth2_clientid (Client ID), oauth2_token_url (Token URL), oauth2_token_method (Token Request Method), oauth2_client_secret (Client Secret), oauth2_authorization_url (Authorization URL), oauth2_client_auth_value (Client Auth Header Value), oauth2_client_auth_header (Client Auth Header), oauth2_client_auth_method (Client Authentication)
  • base.webservice.adapter · modelo nuevo
  • oauth2.requests.web.application · modelo nuevo
  • oauth2.requests.backend.application · modelo nuevo

Texto generado por IA (DeepSeek) al leer el código de la versión 19.0 en GitHub; puede contener errores, así que verifícalo en el código antes de decidir. Ver el código en GitHub

Disponibilidad por versión

Revisado: 2026-11-03
Confirmado (verificado en repositorio y rama) Estimado (sin verificar) Sin información

Estado de confirmación: 8 confirmadas, 1 sin información de 9 versiones.

terminal Instalación y uso

Documentación de OCA · Odoo 19.0

Configuración

Fuente · Odoo 19.0

OAuth2 (Client Credentials)

Para el flujo Backend Application (Client Credentials Grant), dos opciones adicionales controlan cómo se solicita el token, de modo que los endpoints que se desvían de la especificación OAuth2 puedan seguir utilizándose:

  • Token Request Method: POST (predeterminado) o GET. La mayoría de los proveedores exponen el endpoint de token como POST; algunos requieren GET.
  • Client Authentication: cómo se presentan las credenciales del cliente al endpoint de token:
  • Client ID & Secret (HTTP Basic) (predeterminado): el client id y el secret se envían como cabecera Authorization: Basic base64(client_id:client_secret) (client_secret_basic).
  • Custom Authorization header: se envía un valor de cabecera estático tal cual. Client Auth Header (predeterminado Authorization) y Client Auth Header Value se configuran directamente; los campos Client ID / Client Secret no se utilizan en este caso.

Example: custom Authorization header

Algunos proveedores requieren las credenciales en una cabecera Authorization no estándar (por ejemplo, Okta usa Authorization: SSWS <token>). Un endpoint así puede configurarse como:

Auth Type = OAuth2 OAuth2 Flow = Backend Application (Client Credentials Grant) Token URL = https://provider.example.com/oauth2/token Token Request Method = GET Client Authentication = Custom Authorization header Client Auth Header = Authorization Client Auth Value = SSWS

Cuando una base de datos se neutraliza, las credenciales almacenadas del backend de webservice (username, password, API key, OAuth2 client id/secret/token, valor de cabecera de autenticación OAuth2 personalizada) se borran.

Traducción automática al español (DeepSeek) de la documentación original de OCA; los comandos y el código no se traducen. Sin información verificada en OCA: Instalación, Uso.

info

Datos importados de GitHub: esta ficha refleja la última revisión del catálogo, no una consulta en directo. Verifica siempre en la documentación del módulo y en staging antes de instalar en producción.