$ 83.92
| Required Apps |
•
Discuss (mail)
|
| Community Apps Dependencies |
api_auth_apikey
api_framework_base ekika_utils ekika_widgets |
| Technical Name |
easy_jsonapi
|
| License | OPL-1 |
| Also available in version | 18.0 17.0 16.0 |
Introduction
The Odoo Easy JSON:API module introduces a compliant JSON:API framework to Odoo, enabling developers to expose models as standardized RESTful endpoints. With this integration, external clients can perform structured read and write operations using JSON:API conventions, simplifying interoperability with frontends, third-party tools, and mobile applications. It offers an efficient alternative to Odoo's native XML-RPC or JSON-RPC services.
Key Features
Define JSON:API compliant endpoints based on Odoo models
Support for CRUD operations: create, read, update, delete using standard JSON:API formats
Automatic endpoint generation simplifying setup and reducing boilerplate code
Flexible configuration for specifying accessible models and operations
Secure integration with authentication and permission support
Benefits
Streamlines external integrations with a familiar JSON:API standard
Reduces development effort through auto-generated RESTful endpoints
Enhances clarity and maintainability of API contracts with structured payloads
Enables easy integration with modern frontend frameworks and tools
Improves security and control via model-level access configurations
Compatibility & Technical Details
Technical Name: easy_jsonapi
License: AGPL-3 (common for API frameworks)
Required Modules:
Base REST or API framework module for common API infrastructure
Authentication support modules (e.g. API key or token authentication)
Core Odoo modules like Models, HTTP, and Security
Installation Steps:
Ensure installation of base REST framework and necessary authentication support modules.
Place the easy_jsonapi module into the Odoo Add-Ons directory.
Enable Developer Mode and update the app list.
Install the module via the Apps interface.
Configure JSON:API endpoints by enabling models and allowed operations.
Secure access through appropriate authentication and permissions.
External clients can now perform CRUD operations against Odoo using standard JSON:API patterns.
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.