| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1037 |
| Technical Name |
api_app |
| License | LGPL-3 |
| Website | https://www.zalinotech.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1037 |
| Technical Name |
api_app |
| License | LGPL-3 |
| Website | https://www.zalinotech.com |
REST API App
App Summary: The REST API App enables robust and secure communication with the Odoo database through RESTful API calls. It is specifically designed for developers and system integrators who require a dynamic, configurable, and secure interface to access, manage, and manipulate Odoo models and data programmatically.
Key Features
- Dynamically generate API endpoints for any Odoo model or database table
- Granular access control for specific users or user groups
- Field-level permissions with support for Read, Write, Create, and Delete operations
- Secure API keys and endpoint management to ensure data protection
- Real-time audit logging for tracking API requests and activities
1. READ API Features
Easily generate dynamic read-only API endpoints for any Odoo model. Select specific fields to be exposed via the "Allowed Fields" tab for fine-grained data control.
Enable flexible filtering by dynamically allowing specific filter fields (e.g., ID, Name, etc.) through the "User Filters" tab.
Predefine static filters using the "Default Filters" tab to ensure APIs return only relevant data subsets.
Control data ordering dynamically with the "Order By" tab to sort results by selected fields and directions.
Restrict endpoint access to specific users using the "User List" tab to enforce security policies.
A real-time example of the generated JSON request (e.g., Postman/Curl) is shown at the bottom of the form for quick testing and integration.
2. WRITE API Features
Allow updates to selected fields only via the "Allowed Fields" tab, ensuring controlled data manipulation through the API. Assign authorized users in the "User List" tab to manage access control for update operations. Real-time generated JSON examples help developers test and integrate the API quickly using tools like Postman or Curl.
3. CREATE API Features
Define which fields can be accepted for creation operations using the "Allowed Fields" tab, keeping insertions secure and structured. Restrict create access to authorized users via the "User List" tab. Sample JSON request is auto-generated to assist in seamless integration testing.
4. UNLINK (DELETE) API Features
Provide deletion permissions only to specific users using the "User List" tab to ensure critical data is not removed without authorization. A sample deletion request is shown for quick reference.
5. API Audit Report
Monitor and trace all API interactions in real-time. Each API call is logged in the system with metadata for auditing, diagnostics, and security review.
Closing Remarks
The REST API App is a comprehensive, developer-focused solution for secure and flexible interaction with Odoo data. Whether you are integrating external systems, building mobile applications, or automating backend tasks, this module offers all the essential features to create a stable, audit-compliant, and powerful RESTful environment within Odoo.
Please log in to comment on this module