odoo-addon-base-rest-somconnexio 16.0.1.0.1

Expose the basic REST and public API controllers used in Som Connexió.

This module builds a REST API controller base, to build endpoints on them in the somconnexio application modules.

Table of contents

• Configuration

• Usage

• Contributors

Configuration

Create a API key with a user related with the needed security rights to read and modify contracts.

You can follow the next instruccions:

• Settings > Technical (debug mode) > Auth API Key

• click create and select a user, save.

• communicate the API-KEY to the client or app to use the API.

Usage

Two controllers with two collections are set: - APIKeyController, with an api-key authentication. Collection: “sc.api.key.services” - PublicController, for endpoints with no authentication required. Collection: “sc.public.services”

To use them, create service with a Component class using one of these collections.

class PingPublicAPIService(Component):
    _name = "ping.public.api.service"    # name for the new component
    _inherit = "base.rest.service"       # always inherit from base.rest.service (se base_rest module)
    _collection = "sc.public.services"   # collection to use
    _usage = "ping"  # service_name      # collection path
    _description = """
        Ping services (test the public api)
    """

The collection used will inherit its related Controller _root_path and auth method for the given Component The final endpoint will be formed by the Controller _root_path plus the Component usage plus its child endponts defined in their methods. Example: “/public-api/ping/create”

You can see the PingAuthAPIService or PingPublicAPIService services, left as model references.

Also, a “common_service” test class is created for tests purposes. Tests classes using endpoints can inherit from it to use its API call methods.

Contributors

• Som Connexió SCCL <https://somconnexio.coop/>

  • Gerard Funonsas [e-mail]

  • Borja Gimeno [e-mail]

• Coopdevs Treball SCCL <https://coopdevs.coop/>

  • Daniel Palomar [e-mail]

  • Cesar Lopez [e-mail]

  • Carla Berenguer [e-mail]