MuK REST API for Odoo

by
Odoo 5

209.74

v 16.0 Third Party 463
Live Preview
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 7554
Technical Name muk_rest
LicenseSee License tab
Websitehttp://www.mukit.at
Versions 17.0 13.0 12.0 11.0 15.0 14.0 16.0 10.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 7554
Technical Name muk_rest
LicenseSee License tab
Websitehttp://www.mukit.at
Versions 17.0 13.0 12.0 11.0 15.0 14.0 16.0 10.0

MuK REST for Odoo

A customizable RESTful API for Odoo

MuK IT GmbH - www.mukit.at

Community Enterprise onPremise Odoo.sh Odoo Online

Overview

Enables a REST API for the Odoo server. The API has routes to authenticate and retrieve a token. Afterwards, a set of routes to interact with the server are provided. The API can be used by any language or framework which can make an HTTP requests and receive responses with JSON payloads and works with both the Community and the Enterprise Edition.

To activate the routes even if no database is selected the module should be loaded right at the server start. This can be done by editing the configuration file or passing a load parameter to the start script.

Parameter: --load=web,muk_rest

To access the API in a multi database enviroment without a db filter, the name of the database must be provided with each request via the db parameter ?db=database_name.

Key Features

Documentation

The API is documented based on the Open API specification. All endpoints are described in great detail and a number of defined schemas make it possible to keep a good overview of the required parameters as well as the returned results.

Furthermore, the documentation is automatically extended with the addition of another endpoint. Whether it was added as custom endpoint or via Python code does not matter.

Custom Endpoints

In addition to the existing API endpoints, more can easily be added. It is not necessary to write any kind of code. New endpoints can be created in the backend and are immediately available through the API.

Different types of endpoints can be created. For example the domain evaluation can be used to query certain data and return it via the API. While other option are to run a server action or execute custom Python code. Any custom routes are automatically added to the documentation and can be further customized to define parameters and return values.

Connect to the API

The API allows authentication via OAuth1 and OAuth2 as well as with username and password, although an access key can also be used instead of the password. The documentation only allows OAuth2 besides basic authentication. The API has OAuth2 support for all 4 grant types. For OAuth, advanced security can be enabled to allow only certain endpoints and parameters.

Code Example - OAuth2 Authentication

This example shows a login via OAuth2 and then some sample calls to the API. The Python libraries requests and requests_oauthlib are used to connect to the API. Note that this is only an example, the client and implementation can vary depending on the actual requirements.

import json
import requests

from pprint import pprint

from requests_oauthlib import OAuth2Session
from oauthlib.oauth2 import BackendApplicationClient

class RestAPI:
    def __init__(self):
        self.url = 'https://demo12.mukit.at'
        self.client_id = 'BackendApplicationFlowDemoClientKey'
        self.client_secret = 'BackendApplicationFlowDemoClientSecret'
        self.client = BackendApplicationClient(client_id=self.client_id)
        self.oauth = OAuth2Session(client=self.client)

    def route(self, url):
        if url.startswith('/'):
            url = "%s%s" % (self.url, url)
        return url

    def authenticate(self):
        self.oauth.fetch_token(
            token_url=self.route('/api/v1/authentication/oauth2/token'),
            client_id=self.client_id, client_secret=self.client_secret
        )

    def execute(self, enpoint, type="GET", data={}):
        if type == "POST":
            response = self.oauth.post(self.route(enpoint), data=data)
        elif type == "PUT":
            response = self.oauth.put(self.route(enpoint), data=data)
        elif type == "DELETE":
            response = self.oauth.delete(self.route(enpoint), data=data)
        else:
            response = self.oauth.get(self.route(enpoint), data=data)
        if response.status_code != 200:
            raise Exception(pprint(response.json()))
        else:
            return response.json()

# init API
api = RestAPI()
api.authenticate()

# test API
pprint(api.execute('/api/v1'))
pprint(api.execute('/api/v1/user'))

# sampel query
data = {
    'model': "res.partner",
    'domain': json.dumps([['parent_id.name', '=', "Azure Interior"]]),
    'fields': json.dumps(['name', 'image_small']),
}
response = api.execute('/api/v1/search_read', data=data)
for entry in response:
    entry['image_small'] = entry.get('image_small')[:5] + "..."
pprint(response)

# check customer
data = {
    'model': "res.partner",
    'domain': json.dumps([['name', '=', "Sample Customer"]]),
    'limit': 1
}
response = api.execute('/api/v1/search', data=data)
customer = next(iter(response), False)

# create customer
if not customer:
    values = {
        'name': "Sample Customer",
    }
    data = {
        'model': "res.partner",
        'values': json.dumps(values),
    }
    response = api.execute('/api/v1/create', type="POST", data=data)
    customer = next(iter(response))

# create product
values = {
    'name': "Sample Product",
}
data = {
    'model': "product.template",
    'values': json.dumps(values),
}
response = api.execute('/api/v1/create', type="POST", data=data)
product = next(iter(response))

# create order
values = {
    'partner_id': customer,
    'state': 'sale',
    'order_line': [(0, 0, {'product_id': product})],
}
data = {
    'model': "sale.order",
    'values': json.dumps(values),
}
response = api.execute('/api/v1/create', type="POST", data=data)
order = next(iter(response))
	      

The API as a Framework

The REST API is also designed as a framework and can be used as a basis for an extension to fit the individual requirements. This code example shows how easy it is to define an endpoint. The parameters in the @api_docs annotation are optional. If no parameters are given, dynamic default values are generated based on the function signature.

class CommonController(http.Controller):

	@core.http.rest_route(
	    routes=build_route('/user'),
	    methods=['GET'],
	    protected=True,
		docs=dict(
			tags=['Common'],
			summary='User',
			description='Returns the current user.',
			responses={
				'200': {
					'description': 'Current User',
					'content': {
						'application/json': {
							'schema': {
								'$ref': '#/components/schemas/CurrentUser'
							},
							'example': {
								'name': 'Admin',
								'uid': 2,
							}
						}
					}
				}
			},
			default_responses=['400', '401', '500'],
		),
	)
	def user(self, **kw):
	    return make_json_response({
	        'uid': request.session and request.session.uid,
	        'name': request.env.user and request.env.user.name
	    })
	      

Clients

There are already very good REST clients in almost every programming language. For example, in Python there is the Requests library to make HTTP calls and Requests-OAuthlib to authenticate with OAuth, to name just one.

But in case you want to create your own client, you can automatically generate one based on the API documentation. The client is created by Swagger CodeGen and can serve as a good starting point.

Help and Support

Feel free to contact us, if you need any help with your Odoo integration or additional features.
You will get 30 days of support in case of any issues (except data recovery, migration or training).

Our Services

Odoo
Development

Odoo
Integration

Odoo
Infrastructure

Odoo
Training

Odoo
Support

MuK REST API for Odoo

Enables a REST API for the Odoo server. The API has routes to authenticate and retrieve a token. Afterwards, a set of routes to interact with the server are provided. The API can be used by any language or framework which can make an HTTP requests and receive responses with JSON payloads and works with both the Community and the Enterprise Edition.

The API allows authentication via OAuth1 and OAuth2 as well as with username and password, although an access key can also be used instead of the password. The documentation only allows OAuth2 besides basic authentication. The API has OAuth2 support for all 4 grant types. More information about the OAuth authentication can be found under the following links:

  • OAuth1 - RFC5849
  • OAuth2 - RFC6749

Requirements

Following you will find a list of requirements. These are not always mandatory to install the module, but without them the functionality will be limited.

OAuthLib

A generic, spec-compliant, thorough implementation of the OAuth request-signinglogic for Python. To install OAuthLib please follow the instructions or install the library via pip.

pip install oauthlib

Installation

To install this module, you need to:

Download the module and add it to your Odoo addons folder. Afterward, log on to your Odoo server and go to the Apps menu. Trigger the debug mode and update the list by clicking on the "Update Apps List" link. Now install the module by clicking on the install button.

Upgrade

To upgrade this module, you need to:

Download the module and add it to your Odoo addons folder. Restart the server and log on to your Odoo server. Select the Apps menu and upgrade the module by clicking on the upgrade button.

Configuration

In case the module should be active in every database just change the auto install flag to True. To activate the routes even if no database is selected the module should be loaded right at the server start. This can be done by editing the configuration file or passing a load parameter to the start script.

Parameter: --load=web,muk_rest

To access the api in a multi database enviroment without a db filter, the name of the database must be provided with each request via the db parameter.

Parameter: ?db=<database_name>

To configure this module, you need to:

  1. Go to Settings -> API -> Dashboard. Here you can see an overview of all your APIs.
  2. Click on Create or go to either Restful API -> OAuth1 or Restful API -> OAuth2 to create a new API.

To extend the API and to add your own routes, go to Settings -> API -> Endpoints and create a new endpoint. An endpoint can be both public and protected and is then only accessible via authentication. An endpoint can either evaluate a domain, perform a server action or execute python code.

Its possible to further customize the API via a set of parameters insde the config file. The following table shows the possible parameters and their corresponding default value.

Parameter Description Default
rest_default_cors Sets the CORS attribute on all REST routes None
rest_docs_security_group Reference an access group to protect the API docs for unauthorized users None
rest_docs_codegen_url Service to generate REST clients https://generator3.swagger.io/api
rest_authentication_basic Defines if the Basic authentication is active on the REST API True
rest_authentication_oauth1 Defines if the OAuth1 authentication is active on the REST API True
rest_authentication_oauth2 Defines if the OAUth2 authentication is active on the REST API True

Parameters from an configuration file can be loaded via the --config command.

Usage

You are able to use the API with a client of your choice or use the client generator as a starting point. For documentation go to Settings -> API -> Documentation -> Endpoints

Credit

In this section you will find information about the contributors and the maintainers of the app.

Contributors

Images

Some pictures are based on or inspired by:

  • Font Awesome
  • Prosymbols
  • Smashicons

Author & Maintainer

This module is maintained by the MuK IT GmbH.

MuK IT is an Austrian company specialized in customizing and extending Odoo. We develop custom solutions for your individual needs to help you focus on your strength and expertise to grow your business.

If you want to get in touch please contact us via mail or visit our website.

MuK Proprietary License v1.0

This software and associated files (the "Software") may only be used
(executed, modified, executed after modifications) if you have
purchased a valid license from MuK IT GmbH.

The above permissions are granted for a single database per purchased
license. Furthermore, with a valid license it is permitted to use the
software on other databases as long as the usage is limited to a testing
or development environment.

You may develop modules based on the Software or that use the Software
as a library (typically by depending on it, importing it and using its
resources), but without copying any source code or material from the
Software. You may distribute those modules under the license of your
choice, provided that this license is compatible with the terms of the
MuK Proprietary License (For example: LGPL, MIT, or proprietary licenses
similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of
the Software or modified copies of the Software.

The above copyright notice and this permission notice must be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
very good application
by
informatik@hospital-eupen.be
on 8/25/23, 9:31 AM

Very good, well-documented application. Ideal for odoo developers


Does not generate client script
by
enriquezav96@gmail.com
on 4/18/23, 2:03 PM Confirmed Purchase

Hello, I bought your module for odoo version 16.0 and I try to use the wizard located in Settings>Api>Clients, but it gives me an error

I would like to know how I can get the generated script?


i need help
by
enriquezav96@gmail.com
on 4/18/23, 2:01 PM Confirmed Purchase



Less documentation on the Odoo side of the API
by
Chigozirim Ogbogu
on 4/18/23, 10:22 AM Confirmed Purchase

I noticed that fields like sudo Evaluation, Wrapped response where not explained. Also, formatting the response to look better than what Odoo returns.

Tools looks okay but one needs to figure out too many things. Yeah also the Oauth2 keeps failing even though all steps take to install the library yet it can't validate.


by
Zdenek Novak
on 2/8/23, 10:26 AM

Hi,

I look for some app for easy configuration of API for connection with PDM software. The target is to create products and BOMs in Odoo and send list of products and product categories to PDM. 

Can you please let me know if your app is able to solve this request?

Thanks a lot for your feedback.

BR, Zdenek


Re:
by
Mathias Markl
on 2/8/23, 6:50 PM Author

Hello,

you use the API in the other direction. That is, if you want to connect PDM to Odoo. The API allows you to send requests from outside e.g. PDM (if this tool can do that) to Odoo to retrieve data or execute functions. If you want to send data from Odoo to another interface have a look at our Webhooks module.

Webhooks: https://apps.odoo.com/apps/modules/16.0/muk_webhooks/