Skip to Content

Odoo Custom APIs with REST json Studio

by

84.48

18.0 0
Live Preview
Required Apps Discuss (mail)
Community Apps Dependencies easy_restjson
api_framework_base
api_auth_apikey
ekika_utils
ekika_widgets
Technical Name restjson_studio
License OPL-1
You bought this module and need support ? Click here!
Technical Name restjson_studio
License OPL-1

Introduction

The Odoo REST JSON Studio module extends Odoo Studio by letting users build RESTful or JSON-based APIs visually—without writing code. Through the familiar Studio interface, users can choose which models, fields, and methods to expose, define endpoints, and configure input/output payloads. This no-code approach simplifies integrations, enabling rapid API deployment and modern system connectivity within Odoo workflows.

Key Features

  • Enable REST and JSON endpoints directly from Odoo Studio without coding

  • Visually select models, fields, and methods to expose as API services

  • Define HTTP methods, URIs, and data schemas through a graphical interface

  • Configure input validation and structured JSON output for API operations

  • Leverage Odoo’s Studio environment to manage security, access rights, and endpoint configuration

Benefits

  • Accelerates API delivery by removing the need for manual development

  • Facilitates integration with external systems—mobile apps, web tools, or third-party platforms—using standard JSON APIs

  • Enhances data control by restricting exposed fields and operations via Studio settings

  • Improves maintainability through visual API definitions within the Studio UI

  • Democratizes API creation across technical and non-technical users within Odoo

Compatibility & Technical Details

Technical Name: restjson_studio

License: Typically LGPL-3 (as standard for Studio add-ons)

Required Modules:

  • Odoo Studio (web_studio)

  • Base REST/JSON API support framework (e.g., core REST controller modules)

  • Security and Access Control modules to manage endpoint protection

Installation Steps:

  1. Place the restjson_studio module into your Odoo Add-Ons directory.

  2. Activate Developer Mode and update the app list.

  3. Install the module via the Odoo Apps interface.

  4. Open Odoo Studio and locate the API or REST section.

  5. Define your API: select models, choose operations (create, read, update, delete), configure endpoint paths, and map input/output formats.

  6. Set access rights and publish the endpoint. Test using API tools or direct HTTP calls.

Odoo 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 the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules 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 Odoo 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.