Metadata-Version: 1.2
Name: odoo12-addon-easy_my_coop_api
Version: 12.0.0.0.1.99.dev13
Summary: Open Easy My Coop to the world: RESTful API.
Home-page: https://www.coopiteasy.be
Author: Coop IT Easy SCRLfs
License: AGPL-3
Description: ================
        Easy My Coop API
        ================
        
        .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
           !! This file is generated by oca-gen-addon-readme !!
           !! changes will be overwritten.                   !!
           !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
        
        .. |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/licence-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-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github
            :target: https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api
            :alt: coopiteasy/vertical-cooperative
        
        |badge1| |badge2| |badge3| 
        
        Open Easy My Coop to the world: RESTful API.
        
        **Table of contents**
        
        .. contents::
           :local:
        
        Usage
        =====
        
        To give access to the API to a structure, go to
        
        - Settings > Technical (debug mode) > Auth API Key
        - click create and select a user, save.
        - communicate the API-KEY to the structure.
        
        It is recommended to create a technical user for the structure belonging to the group "Easy My Coop User".
        For example, for the structure Coop IT Easy, create partner with
        
        - name = coopiteasy-api-user
        - Application Accesses = Cooperative Management / User
        - Platform Structure = Coop IT Easy
        
        Known issues / Roadmap
        ======================
        
        The API should generate and use an external id for records instead
        of odoo's generated id. It would make importing and export data as
        well as migrating across versions easier.
        
        One way would be to use uuid but the default BaseRESTController
        routes would need to be rewritten: they only take integer as ids.
        Another way is to define a sequence per model.
        
        Bug Tracker
        ===========
        
        Bugs are tracked on `GitHub Issues <https://github.com/coopiteasy/vertical-cooperative/issues>`_.
        In case of trouble, please check there if your issue has already been reported.
        If you spotted it first, help us smashing it by providing a detailed and welcomed
        `feedback <https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop_api%0Aversion:%2012.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
        ~~~~~~~
        
        * Coop IT Easy SCRLfs
        
        Contributors
        ~~~~~~~~~~~~
        
        * Coop IT Easy SCRLfs
        * Robin Keunen <robin@coopiteasy.be>
        
        Maintainers
        ~~~~~~~~~~~
        
        This module is part of the `coopiteasy/vertical-cooperative <https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api>`_ project on GitHub.
        
        You are welcome to contribute.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.5
