Odoo Community Association

EDI WebService Core

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

Attach a webservice.backend to an EDI backend, and send EDI exchange files through it.

This module provides:

edi_webservice_component_oca provides the component-based equivalent (components/send.py) - a legacy integration style, kept in its own module so installing it (and component with it) is opt-in. edi_webservice_oca is now just a deprecated umbrella depending on both, kept to preserve existing installations.

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_core README for more details).

On the exchange type you want to send through a webservice, go to the “Execution handlers” tab and set “Sender” to “EDI WebService Send Handler”.

By default the call uses the backend’s own configuration (URL, auth, …). If you want to take full control on if/how the webservice is used you can do it via the exchange type’s advanced settings.

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

execution_model:
  send:
    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 needed for URL interpolation.

In addition, you can use 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.