Metadata-Version: 2.1
Name: odoo-addon-mautic_connector
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo-addon-connector==18.0.*
Requires-Dist: odoo==18.0.*
Requires-Dist: requests
Summary: Connect Odoo to a Mautic instance (OAuth2 backend configuration)
Home-page: https://github.com/OCA/connector-mautic
License: AGPL-3
Author: Escodoo, 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
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

================
Mautic Connector
================

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

.. |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%2Fconnector--mautic-lightgray.png?logo=github
    :target: https://github.com/OCA/connector-mautic/tree/18.0/mautic_connector
    :alt: OCA/connector-mautic
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/connector-mautic-18-0/connector-mautic-18-0-mautic_connector
    :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/connector-mautic&target_branch=18.0
    :alt: Try me on Runboat

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

Base module of the Mautic connector suite. It provides only the
connection to a Mautic instance:

- the ``mautic.backend`` model, holding the connection settings (Mautic
  URL, OAuth2 Client ID / Secret),
- the OAuth2 authorization flow (connect, callback, automatic token
  refresh),
- a *Test Connection* action to verify the credentials are still valid.

This module does not synchronize any business data by itself. It is
meant to be extended by future modules (contacts, tags, segments, ...)
that will depend on it.

**Table of contents**

.. contents::
   :local:

Configuration
=============

1. In Mautic, go to *Settings > API Credentials* and create a new API
   credential using the *OAuth2* authorization method.
2. Go to *Connectors > Mautic Backends* in Odoo and create a new backend
   with the Mautic URL and the Client ID / Client Secret from step 1.
3. Copy the *Callback URL* shown on the backend form and paste it as the
   *Redirect URI* of the Mautic API credential (step 1). Save the Mautic
   credential.
4. Back in Odoo, click *Connect to Mautic*: you will be redirected to
   Mautic to authorize the application, then back to Odoo with the
   backend marked as *Connected*.

Usage
=====

Use the *Test Connection* button on the backend form at any time to
verify the stored credentials are still valid.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector-mautic/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/connector-mautic/issues/new?body=module:%20mautic_connector%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
-------

* Escodoo

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

- Cristiano Mafra Junior <cristiano.mafra@escodoo.com.br>

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

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

|maintainer-CristianoMafraJunior| 

This module is part of the `OCA/connector-mautic <https://github.com/OCA/connector-mautic/tree/18.0/mautic_connector>`_ project on GitHub.

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