| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 313 |
| Technical Name |
Odoo_rest_api |
| License | OPL-1 |
| Website | https://www.micra.digital |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 313 |
| Technical Name |
Odoo_rest_api |
| License | OPL-1 |
| Website | https://www.micra.digital |
Odoo 18 REST API Module
Powerful JSON-RPC Integration for Odoo 18
The Odoo 18 REST API Module provides a comprehensive RESTful interface designed specifically for Odoo 18 using JSON-RPC. Built to leverage Odoo 18's latest features, it enables secure integration with external systems, mobile apps, and third-party services while maintaining Odoo's security model.
Key Features
|
★
Odoo 18 ExclusiveBuilt specifically for Odoo 18's architecture with support for all new features and performance improvements. |
🔒
Secure AuthenticationJWT token-based authentication with user-level permissions and configurable expiration. |
|
🗄️
Full CRUD OperationsCreate, Read, Update, Delete for any Odoo model with comprehensive field support. |
🔍
Advanced SearchFilter records with complex domain filters, sorting, and field selection. |
|
⚙️
Batch Create OperationsPerform multiple Create actions in a single API call for improved efficiency. |
💻
Custom EndpointsExtend the API with your own endpoints for specialized functionality. |
Module Documentation
📋 Overview
Key Features:
- Odoo 18 Exclusive - Built specifically for Odoo 18's architecture
- Secure authentication - JWT token-based authentication with user-level permissions
- Full CRUD operations - Create, Read, Update, Delete for any Odoo model
- Advanced search capabilities - Filter records with complex domain filters
- JSON-RPC compliance - Industry-standard protocol for maximum compatibility
- Batch Create operations - Perform multiple Create actions in a single API call
- Custom endpoints - Extend the API with your own endpoints
- Rate limiting - Prevent abuse with configurable request limits
- CORS support - Cross-origin resource sharing for web applications
Odoo 18 Specific Enhancements:
- Utilizes Odoo 18's improved ORM performance
- Supports Odoo 18's new security features
- Optimized for Odoo 18's Python 3.10+ environment
- Leverages Odoo 18's enhanced caching mechanisms
⚙️ Installation Guide
- Download the module from our repository or the Odoo App Store
- Place it in your Odoo 18 addons directory:
/path/to/odoo18/addons/ - Update your app list: Go to Apps → Update Apps List
- Install the REST API Module from the Apps menu
- Configure user permissions: Settings → Users & Companies → Users
- Enable "API Access" for relevant users
- Set appropriate access rights for API users
- Restart your Odoo 18 service
- Verify installation by accessing:
https://your-odoo-domain.com/api/docs
System Requirements:
- Odoo 18.0 (latest version recommended)
- Python 3.10+
- PostgreSQL 12+
- Minimum 2GB RAM for production use
📚 API Documentation
All API requests are made to the base URL:
https://your-odoo-domain.com/api/docs
Authentication:
To authenticate, send a POST request to /api/login with credentials:
{
"jsonrpc": "2.0",
"method": "call",
"params": {
"db": "your_db_name",
"login": "api_user@example.com",
"password": "secure_password"
}
}
Successful authentication returns a JWT access token valid for 24 hours by default.
Available Endpoints:
Parameters: domain (array), limit (int), offset (int), order_by (string), fields (array)
Parameters: id (int), fields (array)
Parameters: values (object)
Parameters: id (int), values (object)
Parameters: id (int)
Parameters: method (string), args (array), kwargs (object)
💡 Usage Examples
Example Request:
Search for companies with more than 10 employees:
{
"jsonrpc": "2.0",
"method": "call",
"params": {
"domain": [
["is_company", "=", true],
["employee_count", ">", 10]
],
"limit": 5,
"order_by": "name asc",
"fields": ["id", "name", "email", "phone"]
}
}
Example Response:
{
"jsonrpc": "2.0",
"id": null,
"result": {
"status": 200,
"message": "Success",
"count": 3,
"data": [
{
"id": 45,
"name": "Tech Solutions Inc.",
"email": "info@techsolutions.com",
"phone": "+1 800 123 4567"
}
]
}
}
Technical Requirements
| Odoo Version | Compatible with Odoo 18.0 |
| Python Version | Python 3.10 or higher |
| Dependencies | PyJWT, requests, python-dateutil |
Module Screenshots
Visual overview of the REST API module features and interface in Odoo 18.
🛠 Support & Customization
Need custom endpoints, specialized functionality, or assistance with Odoo 18 integration? Our team provides expert support and customization services.
Standard Support: Included with module purchase (6 months)
Premium Support: 24/7 emergency support with 1-hour response time
Contact us: hello@micra.digital
Odoo 18 REST API Module | © 2025 Micra Digital.
Exclusively for Odoo 18 | MIT License
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