REST API Framework
by Baris Genc https://gencbaris.com/odoo_plugins/rest_api_framework/index.html$ 78.22
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 557 |
| Technical Name |
rest_api_framework |
| License | OPL-1 |
| Website | https://gencbaris.com/odoo_plugins/rest_api_framework/index.html |
| Versions | 17.0 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 557 |
| Technical Name |
rest_api_framework |
| License | OPL-1 |
| Website | https://gencbaris.com/odoo_plugins/rest_api_framework/index.html |
| Versions | 17.0 18.0 19.0 |
REST API Framework
RESTful API framework for all modules with OAuth, rate limiting, and Swagger documentation
Production-ready REST API gateway for Odoo. Expose every business module via standardized endpoints, secure them with OAuth 2.0 and API keys, throttle abusive clients, log every request, generate Swagger documentation automatically, and trigger event-driven webhooks. Built for mobile apps, third-party integrations, headless commerce, and microservice architectures.
Key Features
REST API for All Modules
Auto-generated CRUD endpoints for every standard and custom Odoo model with relationship navigation and field-level access control.
OAuth 2.0 Authentication
Industry-standard OAuth 2.0 with authorization code flow, client credentials flow, refresh tokens, and granular scope management.
API Key Management
Generate, rotate, and expire API keys. Per-key permissions on models and methods, plus full usage tracking per consumer.
Rate Limiting and Throttling
Configurable per-minute, per-hour, and per-day request limits, concurrent request limits, burst allowance, and throttling policies.
Request and Response Logging
Complete audit trail with payloads, response codes, duration, and error capture for compliance and debugging.
Swagger and OpenAPI 3.0
Automatic Swagger UI rendering, OpenAPI 3.0 specification export, interactive API testing, and client-code generation.
Webhook Engine
Event-driven webhooks with HMAC signing, automatic retry with exponential backoff, and full delivery logs.
CORS, Pagination, Filtering
Configurable CORS policies, cursor and offset pagination, advanced field operators, multi-field sorting, and sparse fieldsets.
API Versioning
URL- and header-based versioning, deprecation warnings, and backward compatibility guarantees for long-lived integrations.
Batch Operations and GraphQL
Bulk create, update, and delete with transaction support, partial success handling, and an optional GraphQL endpoint with query optimization.
Use Cases
Mobile Applications
Power native iOS and Android apps with secure, well-documented endpoints and offline-friendly pagination.
Third-Party Integration
Sync orders, inventory, and customers with external CRM, ERP, WMS, and marketplace platforms.
Headless Commerce
Drive Next.js, React, or Vue storefronts using Odoo as a pure backend service.
Microservice Architecture
Compose Odoo into a wider distributed system with rate-limited, auditable service boundaries.
Custom Front-End Development
Build dashboards, customer portals, and partner portals on top of the REST API surface.
Why Choose This Module
100% API coverage for every custom and standard Odoo module out of the box.
Sub-100 ms response time on average for typical CRUD operations under load.
99.9% API uptime with predictable rate limiting that protects your Odoo backend.
Zero security breaches via OAuth 2.0, HMAC-signed webhooks, and complete audit logging.
Specifications
- Compatible with Odoo 17.0, 18.0, and 19.0
- License: OPL-1 (Odoo Proprietary License)
- 35+ languages supported
- Author: Baris Genc
- Support: odoo@gencbaris.com
- Website: gencbaris.com
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.
Please log in to comment on this module