| Technical Name |
odoo_json_rpc
|
| License | OPL-1 |
Introduction
The JSON-RPC API module for Odoo offers a robust, standardized way to interact with Odoo from external systems using JSON-RPC. Rather than relying solely on XML-RPC or custom REST endpoints, this module centralizes RPC calls over JSON, allowing clients to call model methods (search, read, write, create, unlink) and custom business logic in a consistent format. It respects Odoo’s permission rules, record rules, and security layers—preserving integrity and control during integration.
Key Features
Provide a JSON-RPC endpoint for Odoo allowing CRUD operations on models
Support calling arbitrary model methods (execute_kw style) via JSON requests
Maintain Odoo’s built-in access control, record rules, and ACL enforcement
Return structured JSON responses including errors, result, and context
Support batching or multiple RPC calls per request (if implemented)
Compatibility with JSON-RPC client libraries in various languages
Benefits
Provides a lightweight, language-agnostic API for external integration
Simplifies building external applications, services or mobile clients that interact with Odoo
Centralizes access through a controlled RPC interface, reducing need for many REST endpoints
Respects security model, so integrations can't circumvent permissions
Enables faster setup of integrations without custom endpoints per model
Compatibility & Technical Details
Technical Name: odoo_json_rpc
Required Modules: Base / Core (rpc, http), Web / JSON controllers
License: As declared in the module manifest (likely Odoo Proprietary or OPL)
Installation Steps:
Install the JSON-RPC module in your Odoo instance.
Ensure web / RPC configuration allows POST requests to the JSON-RPC endpoint.
Configure access rights so that API users have appropriate model permissions.
Use the JSON-RPC API endpoint (e.g. /jsonrpc) to send requests such as authenticate, execute (object calls), etc.
Handle JSON responses including result or error structures.
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.