Metadata-Version: 2.1
Name: odoo-addon-edi_webservice_core_oca
Version: 18.0.1.2.0
Requires-Python: >=3.10
Requires-Dist: odoo-addon-edi_core_oca==18.0.*
Requires-Dist: odoo-addon-webservice_core==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Webservice backend and send handler for EDI: no component dependency
Home-page: https://github.com/OCA/edi-framework
License: AGPL-3
Author: Dixmit, Camptocamp, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

===================
EDI WebService Core
===================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:45b422587372c3d182d575f034f1e5a732d3812d2b6ff4955db9d9808d79ec5d
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
    :target: https://github.com/OCA/edi-framework/tree/18.0/edi_webservice_core_oca
    :alt: OCA/edi-framework
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/edi-framework-18-0/edi-framework-18-0-edi_webservice_core_oca
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/edi-framework&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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

This module provides:

- The ``webservice_backend_id`` field on ``edi.backend``.
- ``edi.webservice.send``, a plain ``send_model_id`` handler that sends
  the exchange file through the backend's webservice - no ``component``
  dependency.

``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**

.. contents::
   :local:

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 webservice backend
you can configure one or more ``webservice.endpoint`` records (path,
HTTP method, ...).

On the exchange type you want to send through a webservice, go to the
"Execution handlers" tab, set "Sender" to "EDI WebService Send Handler",
then pick the "Endpoint" to call in the "Webservice settings" group that
appears - it drives both the URL (backend URL + endpoint path) and the
HTTP method.

Static headers and querystring params are best set directly on the
``webservice.endpoint`` record itself (its "Headers" and "URL Params"
tabs) - prefer that over the exchange type's advanced settings below,
which are meant for one-off, per-exchange-type overrides rather than the
endpoint's own regular configuration.

If you still need extra call parameters beyond what the endpoint (and
its own headers/URL params) provide, you can add them via the exchange
type's advanced settings:

::

   execution_model:
     send:
       webservice:
         kwargs:
           headers:
             X-Custom-Header: foo
           url_params:
             foo: baz

On a webservice endpoint, the *Exchange Types* smart button lists the
exchange types sending through it.

If you want to send data as bytes you can use the option send_as_bytes
on the exchange type (same tab).

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/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 <https://github.com/OCA/edi-framework/issues/new?body=module:%20edi_webservice_core_oca%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
-------

* Dixmit
* Camptocamp

Contributors
------------

- Simone Orsi <simone.orsi@camptocamp.com>
- Enric Tobella <etobella@creublanca.es>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
    :target: https://github.com/etobella
    :alt: etobella
.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
    :target: https://github.com/simahawk
    :alt: simahawk

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-etobella| |maintainer-simahawk| 

This module is part of the `OCA/edi-framework <https://github.com/OCA/edi-framework/tree/18.0/edi_webservice_core_oca>`_ project on GitHub.

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