| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 761 |
| Technical Name |
aj_dynamic_api |
| License | OPL-1 |
| Website | https://ajodoo.odoo.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 761 |
| Technical Name |
aj_dynamic_api |
| License | OPL-1 |
| Website | https://ajodoo.odoo.com |
AJ Dynamic API REST API Builder for Odoo 18
Build and expose fully secured REST API endpoints directly from Odoo — no coding required. Configure your endpoints visually, map model fields, and protect every route with JWT authentication using Odoo's native API keys. Supports GET, POST, PUT, PATCH and DELETE methods out of the box.
System Parameters
Control the JWT secret key and token expiry duration directly from Settings → Technical → Parameters → System Parameters. No code changes needed — update and the new values take effect immediately.
System parameters: aj_api.secret_key and aj_api.token_expiry_hours
Authentication Endpoint
A pre-configured Authenticate endpoint is created automatically on install. Send your Odoo username and API key to receive a JWT token valid for the configured number of hours. This record is protected and cannot be edited or deleted.
The Authenticate endpoint record with Is Token API protection enabled
Each endpoint record includes a built-in API Info panel with full usage instructions, example request/response, and field reference — auto-generated when you select the HTTP method.
Auto-generated API Info panel showing request format, example response, and system parameter guide
Features
- Visual Endpoint Builder — Create REST endpoints from a simple form — no Python required
- JWT Authentication — Every endpoint is protected with signed JWT tokens
- All HTTP Methods — Supports GET, POST, PUT, PATCH and DELETE from a single controller
- Field Mapping — Map model fields to custom JSON keys for clean API responses
- User-Scoped Queries — Requests run under the token user's environment, respecting Odoo access rights
- Soft & Hard Delete — Archive records by default, or permanently delete with
hard_delete=true - Auto API Docs — API Info panel auto-generates on method selection with full usage guide
- Protected System Records — Token endpoint is locked from edits and deletion via
is_token_apiflag - System Parameters — Configure secret key and token expiry from Odoo UI without touching code
- Version Support — Endpoint URLs include API version (v1—v5) for clean versioning
GET Fetch Records
Retrieve records from any Odoo model. Pass filter parameters as query string arguments. Only records accessible to the authenticated user are returned.
GET endpoint configuration with field mappings
Auto-generated GET API Info with example request and response
POST — Create Records
Create new records in any configured model. Send field values as a JSON body using the mapping keys defined in the Field Mappings tab.
POST endpoint configuration
Auto-generated POST API Info with body format and response example
PUT — Full Update
Fully replace a record's mapped fields. Any field not included in the payload
will be cleared. Requires id in the request body.
PUT endpoint configuration
Auto-generated PUT API Info highlighting full-replace behaviour
PATCH — Partial Update
Update only the fields you send. All other fields on the record remain unchanged. Ideal for updating a single field without affecting the rest of the record.
PATCH endpoint configuration
Auto-generated PATCH API Info showing partial update behaviour
DELETE — Remove Records
Archive or permanently delete records. By default a soft delete (archive)
is performed. Add hard_delete=true as a query parameter for permanent removal.
Auto-generated DELETE API Info showing soft and hard delete options
Use Cases
- Expose Odoo data to external mobile or web applications
- Integrate Odoo with third-party platforms (e-commerce, ERP, CRM)
- Build custom dashboards that pull live data from Odoo models
- Connect Odoo with automation tools like Zapier, Make, or n8n
- Allow external systems to create or update records in Odoo securely
Technical Details
| Authentication | JWT (HS256) via Odoo native API keys |
| HTTP Methods | GET, POST, PUT, PATCH, DELETE |
| Endpoint Model | aj.api.endpoint |
| Field Mapping Model | aj.api.field.mapping |
| Token Config | ir.config_parameter (aj_api.secret_key, aj_api.token_expiry_hours) |
| User Scoping | Queries run under the authenticated user's environment |
| API Versions | v1, v2, v3, v4, v5 |
| Dependencies | PyJWT (pip install pyjwt) |
| Odoo Version | 18.0 |
| License | OPL-1 |
Installation
- Install the PyJWT library on your server:
pip install pyjwt - Download and place the aj_dynamic_api module in your Odoo addons directory.
- Restart the Odoo server.
- Go to Settings and activate Developer Mode.
- Navigate to Apps, search for AJ Dynamic API, and click Install.
- Go to Settings → Technical → Parameters → System Parameters and update
aj_api.secret_keywith a strong secret for production. - Generate an Odoo API key from your profile under Account Security.
- Call
POST /api/v1/authenticatewith your username and API key to receive a JWT token. - Use the token in the
Authorization: Bearer <token>header for all other requests.
AJ Dynamic API by Ajodoo • Built for Odoo 18 • Licensed under OPL-1
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