Odoo Community Association

EDI WebService Component

Beta License: AGPL-3 OCA/edi-framework Translate me on Weblate Try me on Runboat

Provides the component-based edi.webservice.send integration for EDI Exchange records (configured via an exchange type’s advanced settings, under components: send: usage: webservice.send), for setups that still rely on it - including any custom _inherit of this component.

It used to be part of edi_webservice_oca itself; it now lives here so that installing edi_webservice_oca no longer requires component unless you actually need this integration style.

This module itself is not deprecated: it’s the supported way to get component-based integration on demand. The integration style is the legacy one, though - new exchange types should use the model-based handler in edi_webservice_core_oca instead (selected via send_model_id).

Table of contents

Configuration

Go to “EDI -> Config -> Backends” and edit or create one. Find the tab “Webservice” and add a webservice. On the webservice record you can specify all the general parameters to connect to the service (see webservice README for more details).

If you want to take full control on if/how the webservice is used you can do it via exchange type’s advanced settings.

Hence, assuming your webservice has a URL configured as `https://my.endpoint/%7Bpath%7D`:

components:
  send:
    usage: webservice.send  # or any custom component usage inheriting from this
    work_ctx:
      webservice:
        method: post  # mandatory
        kwargs:
          url_params:
            path: endpoint1/foo

For each call related to this type, you’ll get a POST request against https://my.endpoint/endpoint/foo.

url_params can contain all the keys need for URL interpolation.

In addition, you can user url to override the full url used for the call per exchange type.

If you want to send data as bytes you can use the option send_as_bytes like:

[...]
      webservice:
        send_as_bytes: true
[...]

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

  • Dixmit
  • 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/edi-framework project on GitHub.

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