MuK REST API for Odoo

by
Odoo

112.63

v 10.0 v 11.0 v 12.0 Third Party 136
Live Preview
Included Dependencies
MuK Autovacuum (450 lines of code)
MuK Utils (906 lines of code)
Lines of code 4797
Technical Name muk_rest
LicenseSee License tab
Websitehttp://www.mukit.at
Also available in version v 13.0 v 11.0 v 10.0
You bought this module and need support? Click here!
Included Dependencies
MuK Autovacuum (450 lines of code)
MuK Utils (906 lines of code)
Lines of code 4797
Technical Name muk_rest
LicenseSee License tab
Websitehttp://www.mukit.at
Also available in version v 13.0 v 11.0 v 10.0

MuK REST API for Odoo

A customizable Restful API for Odoo

MuK IT GmbH - www.mukit.at

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.

  • Clients
  • Examples
  • Documentation
  • FAQs

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

Key Features

Authentication with the server can be done either via OAuth1 or OAuth2.
All Grant Types are supported by the API

  • OAuth1 - Authentication

  • Temporary Credentials Acquisition
  • POST
    /api/authentication/oauth1/initiate
  • Authorization
  • GET
    /api/authentication/oauth1/authorize
  • Token Exchange
  • POST
    /api/authentication/oauth1/token
  • OAuth2 - Authentication

  • Authorization
  • GET
    /api/authentication/oauth2/authorize
  • Token Exchange
  • POST
    /api/authentication/oauth2/token
  • Token Revocation
  • POST
    /api/authentication/oauth2/revoke

These API endpoints can be used to communicate with the system

  • Version
  • GET
    /api
  • Languages
  • GET
    /api/languages
  • Countries
  • GET
    /api/countries
  • User Info
  • GET
    /api/userinfo
  • Binary
  • GET
    /api/binary/{xmlid}
  • GET
    /api/binary/{xmlid}/{filename}
  • GET
    /api/binary/{id}
  • GET
    /api/binary/{id}/{filename}
  • GET
    /api/binary/{id}-{unique}
  • GET
    /api/binary/{id}-{unique}/{filename}
  • GET
    /api/binary/{model}/{id}/{field}
  • GET
    /api/binary/{model}/{id}/{field}/{filename}
  • Modules
  • GET
    /api/modules
  • Call
  • POST
    /api/call/{model}
  • POST
    /api/call/{model}/{method}
  • User
  • GET
    /api/user
  • Session
  • GET
    /api/session
  • Reports
  • GET
    /api/reports{name}
  • GET
    /api/reports/{name}{model}
  • Report
  • GET
    /api/report{report}
  • GET
    /api/report/{report}{type}

These API endpoints can be used to communicate with Odoo models

  • Field Names
  • GET
    /api/field_names/{model}
  • Fields
  • GET
    /api/fields/{model}
  • Metadata
  • GET
    /api/metadata/{model}
  • Create
  • POST
    /api/create/{model}
  • Write
  • PUT
    /api/write/{model}
  • Unlink
  • DELETE
    /api/unlink/{model}
  • Search
  • GET
    /api/search/{model}
  • GET
    /api/search/{model}/{order}
  • GET
    /api/search/{model}/{limit}/{order}
  • GET
    /api/search/{model}/{limit}/{offset}/{order}
  • Search Read
  • GET
    /api/search_read/{model}
  • GET
    /api/search_read/{model}/{order}
  • GET
    /api/search_read/{model}/{limit}/{order}
  • GET
    /api/search_read/{model}/{limit}/{offset}/{order}
  • Name
  • GET
    /api/name/{model}
  • Read
  • GET
    /api/read/{model}
  • Search Group
  • GET
    /api/read_group/{model}
  • GET
    /api/read_group/{model}/{orderby}
  • GET
    /api/read_group/{model}/{limit}/{orderby}
  • GET
    /api/read_group/{model}/{limit}/{offset}/{orderby}

These API endpoints can be used to check access rights

  • Access Rights
  • GET
    /api/access/rights/{model}
  • GET
    /api/access/rights/{model}/{operation}
  • Access Rules
  • GET
    /api/access/rules/{model}
  • GET
    /api/access/rules/{model}/{operation}
  • Access Fields
  • GET
    /api/access/fields/{model}
  • GET
    /api/access/fields/{model}/{operation}
  • General Access
  • GET
    /api/access/{model}
  • GET
    /api/access/{model}/{operation}

These API endpoints can be used to interact with the database

  • Master Password
  • POST
    /api/change_master_password
  • List Databases
  • GET
    /api/database/list
  • Backup Database
  • POST
    /api/database/backup
  • Restore Database
  • POST
    /api/database/restore
  • Create Database
  • POST
    /api/database/create
  • Duplicate Database
  • POST
    /api/database/duplicate
  • Drop Database
  • POST
    /api/database/drop

Testing the API

In addition to the sample code, the API can also be tested using our demo page. A short explanation video will help you to get started. You can use the following credentials for authentication:

Client ID: MobileApplicationFlowDemoClientKey
User: demo
Password: demo

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.

Contect to the API

Since the API follows the OAuth1 and OAuth2 standards, it is advisable to use a suitable client that can be found in almost every programming language. A list of some of them can be found at this link.

import json
import requests

from requests_oauthlib import OAuth2Session
from oauthlib.oauth2 import LegacyApplicationClient

client_id = 'LegacyApplicationFlowDemoClientKey'
client_secret = 'LegacyApplicationFlowDemoClientSecret'
token_url = 'https://demo12.mukit.at/api/authentication/oauth2/token'

username = 'demo'
password = 'demo'
scope = ['all']

oauth = OAuth2Session(
    client=LegacyApplicationClient(client_id=client_id)
)
token = oauth.fetch_token(
    token_url=token_url, 
    username=username, password=password,
    client_id=client_id, client_secret=client_secret
)

print(oauth.get("https://demo12.mukit.at/api/user").json())
	      

Find more examples about how to connect to the API via a OAuth client in the documentation.

Extend the API

Even if the API is extended using Python code, the REST API framework provides a number of helpers. Keep in mind that if these extensions are included in a new module, it may also have to be loaded as a global module to make the created endpoints available without a selected database.

from odoo import http
from odoo.http import request, Response

from odoo.addons.muk_rest import tools
from odoo.addons.muk_rest.utils.json import ResponseEncoder		
				
class ModelController(odoo.http.Controller):

	@odoo.http.route([
	    '/api/myapp/myroute'
	], auth="none", type='http', methods=['GET'], csrf=False)
	@tools.common.parse_exception
	@tools.common.ensure_database
	@tools.common.ensure_module()
	@tools.security.protected()
	def myroute(self, **kw):
	    result = ...
	    content = json.dumps(result, sort_keys=True, indent=4, cls=ResponseEncoder)
	    return Response(content, content_type='application/json;charset=utf-8', status=200)
	      

Read more about creating your own API and how to use the provided helpers in the documentation.

Our Services

Odoo
Implementation

Odoo
Integration

Odoo
Customization

Odoo
Development

Odoo
Support

Help and Support

Feel free to contact us, if you need any help with your Odoo integration or addiontal features.
You will get 30 Days free support incase of any bugs or issues (Except data recovery or migration).

Restful API

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.

Requirements

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.

Another way to install this module is via the package management for Python (PyPI).

To install our modules using the package manager make sure odoo-autodiscover is installed correctly. Then open a console and install the module by entering the following command:

pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>

The module name consists of the Odoo version and the module name, where underscores are replaced by a dash.

Module:

odoo<version>-addon-<module_name>

Example:

sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils

Once the installation has been successfully completed, the app is already in the correct folder. 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.

The biggest advantage of this variant is that you can now also update the app using the "pip" command. To do this, enter the following command in your console:

pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>

When the process is finished, restart your server and update the application in Odoo. The steps are the same as for the installation only the button has changed from "Install" to "Upgrade".

You can also view available Apps directly in our repository and find a more detailed installation guide on our website.

For modules licensed under OPL-1, you will receive access data when you purchase the module. If the modules were not purchased directly from MuK IT please contact our support (support@mukit.at) with a confirmation of purchase to receive the corresponding access data.

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.

If you installed the module using the "pip" command, you can also update the module in the same way. Just type the following command into the console:

pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>

When the process is finished, restart your server and update the application in Odoo, just like you would normally.

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 configure this module, you need to:

  1. Go to Settings -> Restful 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.

Usage

This module provides a set of routes to interact with the system via HTTP requests. Take a look at the clients and examples or open the documentation to get a detailed description of every available route.

Credits

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 (sale@mukit.at) or visit our website (https://mukit.at).

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.
There are no ratings yet!
SwaggerHub for tests still pointing to demo12 ?
by
Verone Jewels
on 11/13/19, 2:11 AM

Thanks Mathias Markl for the answer, here: https://app.swaggerhub.com/apis-docs/keshrath/muk_rest/3.0.0#/Authentication/post_api_authentication_oauth1_initiate Is this this SwaggerHib still pointing to demo12 like it seems ? Thanks :)


by
Mathias Markl
on 11/12/19, 6:11 AM Author

The demo has been moved to demo.mukit.at instead of demo12.mukit.at


Could you please fix the demo API server ?
by
Verone Jewels
on 11/12/19, 5:38 AM

Is http://demo12.mukit.at/api/authentication/oauth2/authorize still available to do demo tests of API ? And the certificate also, seems expired. If I do tests on PostMan, it gives: " default backend - 404"

Re: Could you please fix the demo API server ?
by
Mathias Markl
on 11/12/19, 6:10 AM Author

Thx for the info. We will fix it.


Interested in buying the module
by
Luis Vazquez
on 7/18/19, 5:49 PM

Hi, is it possible to work with odoo.sh and working directly on creating new contacts and crm opportunities from an outside web page ? thanks, -LV

Re: Interested in buying the module
by
Mathias Markl
on 7/19/19, 2:11 AM Author

Yes


Looks very well built, but...
by
Andres Fontenele
on 6/24/19, 11:51 AM

... if you could point the main advantages over the standard odoo API, it would probably be selling more =)

Re: Looks very well built, but...
by
Mathias Markl
on 6/24/19, 1:51 PM Author

Odoo uses XMLRPC as their API. The biggest advantage of a REST API is that there is excellent support for REST clients in every language. Additionally, the API provides OAuth as an authentication method. Since this is also a standard a suitable client exists in almost every language. OAuth allows you to login to the Odoo server with a client key/secret. This has the big advantage that no user data has to be passed on to an external app. In addition, the access rights can be set individually and therefore the external app can only have access the desired data.


by
Aaron
on 4/11/19, 3:45 PM

Does it work for V8.0

Re:
by
Mathias Markl
on 6/24/19, 1:43 PM Author

It only works for the specified versions.