API Request Logger
by Viindoo
| Lines of Code | 880 |
| Technical name | viin_api_request_logger |
| License | OPL-1 |
| Website | https://viindoo.com/apps/modules/17.0/viin_api_request_logger |
| Read description for | v 18.0 v 19.0 |
| Extensions | Viindoo AI Integration with Zalo OA Viindoo Unified Routing Framework Mapbox Matrix API Integration Vietmap Matrix & Routing API Integration HERE Routing API Integration Google Routes API Integration SeaRoutes Ocean Routing Integration |
What the API was asked, and what it answered
A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.
API Request Logger (technical name viin_api_request_logger) is an Odoo 17.0 app for Odoo Community and Odoo Enterprise and Viindoo Cloud, built for integrator, support, developer, administrator.
At a Glance
The facts of API Request Logger, version 0.1.1, in one place. Published by Viindoo.
How It Works
Two screens.
The requests
Endpoint, method and response status - the list a support engineer opens first.
One request
What was sent and what was answered, in full.
What You Get
A central log of API requests and their responses
Method, endpoint, payload, status and response headers
A mixin so a record can link to the last request that touched it
Readable by administrators, in the back office
Useful for debugging and for settling integration disputes
Nothing changes about how the API behaves
More Screens
Everything below was taken on a database seeded with real business data, on this series - not a mock-up and not a screenshot from an older version.
A request
What This App Does Not Do
Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.
Re-sending a failed call is the integration's job.
Plan a retention policy - a busy API produces a lot of rows.
Restrict access accordingly; the model is administrator-facing on purpose.
It records requests that arrived, not the ones that never did.
Works Well With
Apps from the same stack, built to fit this one:
Who Should Use API Request Logger?
Integrator
Sees the request as it arrived, not as it was described.
Support
Answers whether a call reached the system.
Developer
Debugs from data instead of from a reproduction attempt.
Administrator
Keeps a trail of what external systems are doing.
Frequently Asked Questions
What does API Request Logger do?
A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.
What does API Request Logger not do?
It logs; it does not replay. Re-sending a failed call is the integration's job. Logs grow. Plan a retention policy - a busy API produces a lot of rows. Payloads may contain personal data. Restrict access accordingly; the model is administrator-facing on purpose. It does not monitor uptime. It records requests that arrived, not the ones that never did.
Who is API Request Logger for?
Integrator: Sees the request as it arrived, not as it was described. Support: Answers whether a call reached the system. Developer: Debugs from data instead of from a reproduction attempt. Administrator: Keeps a trail of what external systems are doing.
Which Odoo version and editions does it support?
Odoo 17.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.
What does it depend on?
It installs on top of: base, bus. Odoo installs them with it.
How do I set it up?
Two screens.
What works well with it?
Expiring Tokens (to_token_expiration): The other half of API hygiene. Bank Connector (viin_bank_connector): An integration worth logging. Viindoo Base (to_base): The foundation layer.
Can I try it before buying?
Yes - the Live Preview button at the top of this page opens the module's own screen on a working database.
How do I get support?
Write to apps.support@viindoo.com with your Odoo version and the technical name viin_api_request_logger; pre-sales questions go to sales@viindoo.com.
See API Request Logger in Action
Live demo: v17demo-int.viindoo.com/web#action=viin_api_request_logger.action_api_request_log
Need help with API Request Logger?
For questions, implementation support or a custom feature, contact Viindoo.
Pre-Sales & Partnership
sales@viindoo.comUpgrades to a newer Odoo series are a separate purchase for that series.
All Viindoo apps: apps.odoo.com/apps/modules/browse?author=Viindoo
Technical Requirement
Changes log
0.1.1 - Latest on the 17.0 line
- A viewer mixin lets a record point at the last API request that touched it.
API Request Logger Documentation
Overview
The viin_api_request_logger module provides a framework for logging and monitoring API requests in Odoo. Designed for developers and administrators, it tracks all details of API interactions, including:
- User initiating the request
- Related model and record
- Request parameters, headers, and payload
- API response data and errors
- Request duration
Key Features
- Detailed Logging: Capture all request/response details, including errors.
- Secret-Safe Transport Logs: Sensitive header and query-string secrets are masked before being written to api.request.log.
- Error Monitoring: Automatically logs failed API requests for better debugging.
- Extensible Integration: Easily integrate with models using the provided mixins.
- User-Friendly API Log Viewer: Quickly access logs related to any model record.
- Customizable: Fully adaptable for specific business needs.
Installation
Install the module via the Odoo Apps interface or the command line:
odoo-bin -c <config_file> -i viin_api_request_logger
Configure user access rights to ensure secure access to logs.
Usage
Logging API Requests
To enable automatic logging for API requests, inherit the api.request.mixin in your model and use the make_request method. Here's an example:
class ExampleIntegration(models.AbstractModel): _name = 'example.integration' _inherit = 'api.request.mixin' def example_api_call(self): response = self.make_request( method="GET", url="https://api.example.com/data", headers={"Authorization": "Bearer <token>"}, params={"key": "value"}, res_model="example.model", res_id=1, ) return response.json()
Viewing API Logs
To allow users to view related logs, inherit the api.log.viewer.mixin in your model. This mixin provides:
- `last_api_request_log_id`: A computed field showing the most recent API log.
- `action_view_api_logs`: An action to display all related logs.
Example:
class ExampleModel(models.Model): _name = 'example.model' _inherit = 'api.log.viewer.mixin'
Logs can also be accessed via the "API Logs" menu in the Odoo interface.
Logging Guarantees
- request_headers always masks default sensitive headers such as Authorization and X-API-Key.
- request_url and name store the effective request URL, including query parameters expanded from params, with sensitive query-string values masked.
- Each outbound API call creates a single api.request.log record, including HTTP 4xx/5xx responses.
- Non-JSON responses fall back to raw response.text so HTML/plain-text vendor error pages still appear in the log.
Customizing the Logger
Override _prepare_log_values to include custom fields in the log:
def _prepare_log_values(self, method, url, headers, data, response, duration, res_model=None, res_id=None, error_message=None): values = super()._prepare_log_values(method, url, headers, data, response, duration, res_model, res_id, error_message) values.update({"custom_field": "Custom Value"}) return values
Configuration
The module works out-of-the-box but can be extended for advanced configurations.
Advanced Scenarios
- Custom Headers: Use the headers parameter in make_request to add headers such as authentication tokens.
- Sensitive Query Parameters: Override _get_sensitive_query_param_keys() to mask provider-specific secret query parameters in logged URLs.
- API Monitoring: Leverage the response_headers and response_data fields to debug or analyze responses.
- Integration with External Tools: Export logs for use with monitoring tools like ELK Stack or Datadog.
Support
For assistance, please contact Viindoo support at https://viindoo.com.
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.