Metadata-Version: 2.1
Name: odoo-addon-base_external_system_http
Version: 16.0.1.1.0
Summary: HTTP Connector for External Systems
Home-page: https://github.com/OCA/server-backend
Author: Therp BV, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.10
Requires-Dist: odoo-addon-base-external-system<16.1dev,>=16.0dev
Requires-Dist: odoo<16.1dev,>=16.0a

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

====================
External System HTTP
====================

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

.. |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%2Fserver--backend-lightgray.png?logo=github
    :target: https://github.com/OCA/server-backend/tree/16.0/base_external_system_http
    :alt: OCA/server-backend
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-backend-16-0/server-backend-16-0-base_external_system_http
    :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/server-backend&target_branch=16.0
    :alt: Try me on Runboat

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

This module provides an HTTP(S) adapter for the ``base_external_system`` framework.

It allows Odoo to communicate with external systems over HTTP using a consistent
adapter interface, supporting GET, POST and PUT requests, endpoint resolution,
and connection testing.

The adapter itself acts as the client and is yielded via the standard
``system.client()`` context manager.

**Table of contents**

.. contents::
   :local:

Usage
=====

Create an external system record and optionally define endpoints.

Example configuration:

* Host: ``api.example.com``
* Remote path: ``/v1``

Define endpoints such as:

* ``status`` → ``/status``
* ``items`` → ``/items``

Use the adapter:

.. code-block:: python

    with system.client() as client:
        response = client.get(endpoint="status")
        response = client.post(endpoint="items", json={"name": "Item"})
        response = client.put(endpoint="items", json={"active": True})

Responses are returned as ``requests.Response`` objects.

Errors raise ``ValidationError`` with detailed messages.

Known issues / Roadmap
======================

* Optional authentication helpers
* Optional persistent session support

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/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/server-backend/issues/new?body=module:%20base_external_system_http%0Aversion:%2016.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
~~~~~~~

* Therp BV

Contributors
~~~~~~~~~~~~

* Ronald Portier (Therp BV)
* Nikos Tsirintanis <ntsirintanis@therp.nl>

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-NL66278| image:: https://github.com/NL66278.png?size=40px
    :target: https://github.com/NL66278
    :alt: NL66278
.. |maintainer-ntsirintanis| image:: https://github.com/ntsirintanis.png?size=40px
    :target: https://github.com/ntsirintanis
    :alt: ntsirintanis

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

|maintainer-NL66278| |maintainer-ntsirintanis| 

This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/16.0/base_external_system_http>`_ project on GitHub.

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