| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1831 |
| Technical Name |
http_api_endpoints |
| License | OPL-1 |
| Website | https://www.eqpsolutions.com |
| Versions | 17.0 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1831 |
| Technical Name |
http_api_endpoints |
| License | OPL-1 |
| Website | https://www.eqpsolutions.com |
| Versions | 17.0 18.0 19.0 |
HTTP API Endpoints
Professional API Integration Framework for Odoo
EQP Solutions - www.eqpsolutions.com
Odoo On Premise
Odoo Sh
Overview
The HTTP API Endpoints module provides a powerful, user-friendly framework for integrating with external APIs directly from Odoo. With complete HTTP method support, robust error handling, and built-in monitoring, it's the perfect solution for professional API integrations.
What's New
- Complete HTTP Method Support: GET, POST, PUT, DELETE, and PATCH operations with simple, consistent interfaces.
- Enhanced Error Handling: Robust error handling with user-friendly messages and automatic retry mechanisms.
- Simple Methods: New simple methods that return consistent format for easy integration.
- Built-in Monitoring: Real-time statistics, success rate tracking, and detailed request/response logging.
- Log Retention: Automatic cleanup of old logs with configurable retention policy.
- Demo Endpoints: Pre-configured examples using JSONPlaceholder API for immediate testing.
Key Features
- Complete HTTP Method Support: GET, POST, PUT, DELETE, and PATCH operations with both simple and advanced interfaces.
- Multiple Authentication Types: Basic Auth, Bearer Token, API Key, and Custom Headers support.
- Environment Management: Test and Production URL support with easy switching.
- Retry Mechanisms: Configurable retry attempts with exponential backoff for handling network issues.
- Request Logging: Complete request/response logging with timestamps and duration tracking.
- Success Monitoring: Real-time statistics, success rate tracking, and visual status indicators.
- Log Retention: Automatic daily cleanup of old logs with configurable retention policy.
- Beautiful Interface: Modern kanban interface with color-coded status indicators.
- Company-Specific: Multi-company support with proper access control and data isolation.
- Mixin Integration: Easy-to-use mixin for adding HTTP functionality to any Odoo model.
- Demo Endpoints: Pre-configured examples for immediate testing and learning.
Usage
Quick Start Example
Get started in minutes with our simple mixin approach:
# 1. Add the mixin to your model
class MyModel(models.Model):
_name = 'my.model'
_inherit = ['http.endpoint.mixin']
def fetch_data(self):
# 2. Make API calls with simple methods
result = self.http_get_simple('My API', params={'id': 1})
if not result['error']:
data = result['content']
return data
else:
# Handle error gracefully
return False
class MyModel(models.Model):
_name = 'my.model'
_inherit = ['http.endpoint.mixin']
def fetch_data(self):
# 2. Make API calls with simple methods
result = self.http_get_simple('My API', params={'id': 1})
if not result['error']:
data = result['content']
return data
else:
# Handle error gracefully
return False
That's it! The mixin handles all the complexity - authentication, retries, error handling, and logging.
Available Methods
The module provides two types of methods for different use cases:
Simple Methods (Recommended)
User-friendly methods that return consistent format: {'error': bool, 'content': data}
http_get_simple()- GET requestshttp_post_simple()- POST requestshttp_put_simple()- PUT requestshttp_delete_simple()- DELETE requestshttp_patch_simple()- PATCH requests
Advanced Methods
Full control with complete response objects for power users:
http_get()- GET with full responsehttp_post()- POST with full responsehttp_put()- PUT with full responsehttp_delete()- DELETE with full responsehttp_patch()- PATCH with full response
Demo Endpoints Included
Get started immediately with pre-configured demo endpoints using the JSONPlaceholder API:
GET Endpoints
- JSONPlaceholder Posts (with userId filter)
- JSONPlaceholder Comments (with postId filter)
- JSONPlaceholder Users
- JSONPlaceholder Albums (with userId filter)
- JSONPlaceholder Photos (with albumId filter)
- JSONPlaceholder Todos (with userId/completed filters)
POST Endpoints
- Create Post, Comment, User, Album, Todo
- All with realistic test data in JSON format
PUT/PATCH/DELETE Endpoints
- Update operations (full and partial)
- Delete operations
- All with proper test data
Configuration
To configure this module:
- Install the module through the Odoo Apps menu
- Go to HTTP API Endpoints â Endpoints
- Create new endpoints with URL, method, and authentication settings
- Configure authentication (Basic Auth, Bearer Token, API Key, or Custom Headers)
- Set up test and production URLs
- Use the "Test Connection" button to verify configuration
- Add the mixin to your models and start making API calls
Real-World Use Cases
- CRM Integration: Sync customer data with external CRM systems like Salesforce, HubSpot, or custom solutions.
- Inventory Management: Integrate with warehouse management systems, e-commerce platforms, and fulfillment services.
- Payment Processing: Connect with payment gateways, banking APIs, and financial service providers.
- Communication: Integrate with email services, SMS providers, and notification platforms.
- Analytics & Reporting: Send data to analytics platforms, business intelligence tools, and reporting services.
- Custom Integrations: Connect with any REST API - the possibilities are endless!
Complete Documentation
Everything you need to get started and become an expert:
- Comprehensive README: 800+ lines of detailed documentation with examples, best practices, and troubleshooting.
- Code Examples: Real-world examples for customer sync, inventory management, and order processing.
- Best Practices: Professional guidelines for error handling, security, and performance optimization.
- Troubleshooting: Common issues, solutions, and debugging tips for smooth implementation.
- API Reference: Complete method documentation with parameters and return values.
Official Documentation
Visit our comprehensive documentation for detailed guidance and examples:
View Documentation
https://eqpsolutions.com/blog
https://eqpsolutions.com/blog
Want More?
If you have additional questions or need further assistance, feel free to reach out to us.
Write Us
Contact Us
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