Skip to main content
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 by default the content of the response. A context ‘content_only’ can be passed to get the full response object.

Table of contents

Configuration

OAuth2 (Client Credentials)

For the Backend Application (Client Credentials Grant) flow, two extra options control how the token is requested, so that endpoints which deviate from the OAuth2 spec can still be used:

  • Token Request Method: POST (default) or GET. Most providers expose the token endpoint as a POST; some require a GET.

  • Client Authentication: how the client credentials are presented to the token endpoint:

    • Client ID & Secret (HTTP Basic) (default): the client id and secret are sent as an Authorization: Basic base64(client_id:client_secret) header (client_secret_basic).

    • Custom Authorization header: a static header value is sent verbatim. The Client Auth Header (default Authorization) and Client Auth Header Value are configured directly; the Client ID / Client Secret fields are not used in this case.

Example: custom Authorization header

Some providers require the credentials in a non-standard Authorization header (for instance Okta uses Authorization: SSWS <token>). Such an endpoint can be configured as:

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 <token>

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

Contributors

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 maintainer:

etobella

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_addon_webservice-19.0.1.2.0-py3-none-any.whl (50.0 kB view details)

Uploaded Python 3

File details

Details for the file odoo_addon_webservice-19.0.1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_webservice-19.0.1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aae3f489db43d5ab4f7a4f42ffac7e0c16c002fa976605533bb65befde7e698f
MD5 1ebae37741b708fc2bc91187bcead516
BLAKE2b-256 4671942f0338211494a586772ae1d35c9b07123d260e76d717313e2f1de8491b

See more details on using hashes here.

Release history Release notifications | RSS feed

19.0.1.2.0.2

1 file

19.0.1.2.0.1

1 file

This release

19.0.1.2.0 This release

1 file

19.0.1.1.2.4

1 file

19.0.1.1.2.2

1 file

19.0.1.1.2

1 file

19.0.1.1.1

1 file

19.0.1.1.0.3

1 file

18.0.1.1.2

1 file

18.0.1.1.1.3

1 file

18.0.1.1.1.2

1 file

18.0.1.1.0.2

1 file

18.0.1.1.0.1

1 file

18.0.1.1.0

1 file

18.0.1.0.0.6

1 file

18.0.1.0.0.5

1 file

17.0.1.0.1.1

1 file

17.0.1.0.1

1 file

17.0.1.0.0.10

1 file

17.0.1.0.0.9

1 file

17.0.1.0.0.8

1 file

17.0.1.0.0.7

1 file

17.0.1.0.0.6

1 file

17.0.1.0.0.5

1 file

17.0.1.0.0.4

1 file

17.0.1.0.0.3

1 file

16.0.1.6.0.3

1 file

16.0.1.6.0.2

1 file

16.0.1.6.0.1

1 file

16.0.1.6.0

1 file

16.0.1.5.0

1 file

16.0.1.4.0.2

1 file

16.0.1.4.0.1

1 file

16.0.1.4.0

1 file

16.0.1.3.0.2

1 file

16.0.1.3.0.1

1 file

16.0.1.3.0

1 file

16.0.1.2.0.1

1 file

16.0.1.2.0

1 file

16.0.1.1.0.2

1 file

16.0.1.1.0.1

1 file

16.0.1.1.0

1 file

16.0.1.0.0.10

1 file

16.0.1.0.0.6

1 file

16.0.1.0.0.5

1 file

16.0.1.0.0.4

1 file

15.0.1.0.3

1 file

15.0.1.0.2.2

1 file

15.0.1.0.2.1

1 file

15.0.1.0.2

1 file

15.0.1.0.1

1 file

15.0.1.0.0.6

1 file

15.0.1.0.0.4

1 file

15.0.1.0.0.3

1 file

15.0.1.0.0.2

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page