Odoo Community Association

WebService

Production/Stable License: AGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

This module creates WebService frameworks to be used globally.

The module introduces support for HTTP Request protocol. The webservice HTTP call returns the full requests.Response object.

It builds on top of webservice_core (which provides the webservice.backend model with public/username-password/API key authentication) to add OAuth2 authentication and server_environment support.

Table of contents

Configuration

On upgrade from a version prior to 18.0.2.0.1, a webservice.request_content_only system parameter is created automatically (see that version’s migration script) to preserve the previous default behavior of HTTP calls, which returned only the response content instead of the full requests.Response object.

If your code relies on that implicit default, keep the parameter for now. Once it’s adapted to use the full response object (see Usage), delete the parameter under Settings > Technical > System Parameters - new installs never get it set.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Creu Blanca
  • Camptocamp

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainers:

etobella simahawk

This module is part of the OCA/web-api project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.