| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 293 |
| Technical Name |
ms_rest_api |
| License | OPL-1 |
| Website | https://blog.miftahussalam.com/ |
| Versions | 14.0 16.0 17.0 18.0 19.0 |
Rest API
Build Odoo REST APIs with custom status codes, response formats, and API key authentication
Overview
The Rest API module provides a base framework for building REST APIs on top of Odoo with proper HTTP status codes, customizable response formats, and API key-based authentication. Unlike the native Odoo JSON-RPC API which uses a fixed response format, this module gives developers full control over the API response structure, making integration with external systems much cleaner and more standard.
Key Features
- Custom HTTP status codes for success and error responses
- Configurable JSON response format for all endpoints
- API key authentication without requiring username and password
- Supports GET, POST, PUT, and DELETE operations
- API key management in user preferences
- Postman collection available for testing
Generate API key
Environment variable on postman
Get data with params
Get data with ID
Create data
Edit data
Delete data
Download postman collection and environment variable
- https://drive.google.com/file/d/1jF6r8fvXVJS7R-6snyoHOf5xMiJjkaDn/view?usp=sharing (Collection)
- https://drive.google.com/file/d/1ErvwMdl3AL_nAGzHZYDUsbNISNJBwUzv/view?usp=sharing (Environment Variable)
Contact
miftahussalam08@gmail.com
https://blog.miftahussalam.com/
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