Key Features

Secure Token-Based Authentication - Protect API access with unique API keys and optional user tokens - Ensure only trusted clients and authenticated users can interact with the API

Complete CRUD Operations via API Keys - Supports:

• GET – View or search records
• POST – Create records or execute methods
• PUT – Update records
• DELETE – Remove records

• Respects Odoo model access rights and security rules

API Key Access with Expiration and Throttling - Set validity period (e.g., 30 days) for API keys - Limit API requests per user per day to prevent misuse and manage performance

Model-Wise Access Control for API Keys - Allow full access to all models or restrict to selected models - Configure per-model CRUD permissions for secure, controlled integration

Interactive Swagger (OpenAPI) Documentation Interface - Explore API endpoints visually via Swagger UI - Perform live testing with authorized tokens and sample data

Documentation for Postman Endpoints Collection - Download ready-to-use Postman collection with authentication setup - Includes sample requests, payloads, and parameter details

Comprehensive API Call Logging - Track all API interactions for auditing and debugging - Store method, endpoint, user, and timestamp information

Dynamic Pagination for Large Datasets - Fetch large datasets efficiently using paginated API responses - Improve performance when retrieving bulk data

Multi-language Support - Translations included for:

• 🇩🇪 German
• 🇫🇷 French
• 🇪🇸 Spanish
• 🇯🇵 Japanese

Summary

Easily integrate your Odoo instance with any external platform using this REST API Odoo module. It supports all CRUD operations on Odoo models with secure, token-based authentication. Admins can manage API keys, set model-level permissions, and enable advanced features like throttling and key expiration. The app also includes Swagger UI and a Postman Collection to simplify development and testing.

Installation

1. Copy the module folder to your Odoo custom_addons directory.
2. Restart the Odoo server and update the app list.
3. Search for Odoo REST API and install it.
4. Enable developer mode to configure API keys, access rights, and token settings.

How to use this module:

1. Navigate to Settings > Technical > Web Services > Webservice Accounts - Click Create and set up the API key - Enable User Authentication if per-user tokens are required - Select All Models or define Specific Models with CRUD permissions
2. Navigate to Users > User Profile > User Authentication tab - Select the Webservice Account - Click Generate Token to create a secure login token
3. Explore and test the API: - Go to Settings > Technical > Web Services > REST API Document - Use Swagger UI for live API testing - Download the Postman Collection for local testing
4. Start using API endpoints: - GET /api/{model_name}/{id} - POST /api/{model_name}/create - PUT /api/{model_name}/{id} - DELETE /api/{model_name}/{id}

Change logs

[1.0.0] * Added [13-08-2025] – Initial release with CRUD endpoints, authentication, API key management, model-level permissions, throttling, key expiration, Swagger UI, Postman collection, logging, pagination, and multi-language support.

Support

Zehntech Technologies