| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 829 |
| Technical Name |
xbaloot_api_rest |
| License | OPL-1 |
| Website | https://www.xbaloot.com |
| Versions | 16.0 17.0 18.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 829 |
| Technical Name |
xbaloot_api_rest |
| License | OPL-1 |
| Website | https://www.xbaloot.com |
| Versions | 16.0 17.0 18.0 |
Introduction
This document provides a detailed guide on how to use the Odoo API REST module in Odoo. Below, you will find descriptions of the key features, accompanied by illustrative images and a link to our support channel for further assistance.
Installation
To install the module, follow these steps:
- Log in to your Odoo instance with admin privileges.
- Go to Apps in the main menu.
- Search for the Odoo API REST module.
- Click Install.
Configuration
Feature 1: Users
Generate API key from user, using the 'Generate' button.
Feature 2: API Rest
Set the token expiration time(hours).
Features
Feature 1: Rest API Records
Then the records are created where you can choose the model and the http methods. In the case of the 'Add custom method' field, it is used to enable custom method execution on API controller to invoke a custom methods. Please note that you need to develop an extension of the APIs controller and your custom method.
Feature 2: Views
After the record is created, the kanban views are displayed (allowing for a more intuitive and user-friendly experience, adaptable to specific needs and preferences) and search (allows you to search, filter and group records in a view to show the most relevant ones).
Feature 3: Testing with Postman
You can download examples to try in postman The downloaded file is in .zip format, after unzipping it you can import it into POSTMAN.
Feature 4: Postman: API Authentication(STEP 1)
To test with Postman you need to keep the following points in mind: -Replace 'localhost:8071' with the port number of your local host. -Replace the database name, username and password. If authentication is successful, an API key will be generated for the current user. This key will be used for all other API requests.
Feature 5: Postman: Get all records
Get the records corresponding to the model, you must first have the Get method enabled for the model in the Odoo application.
Feature 6: Postman: Create Records
Using the POST method, you can create new records. Always specifying the model, and you must have the POST method enabled for the model in the Odoo application. To create a record, you must have the JSON data corresponding to the model.
Feature 7: Postman: Update Record
Using the PUT method, you can modify records. Always specifying the model and also the id or the record that you want to update. you must have the PUT method enabled for the model in the Odoo application.
Feature 8: Postman: Delete Record
Records can be deleted by sending a request with the DELETE method. Always specify the model and also the ID of the record you want to delete. You must have the DELETE method enabled for the model in the Odoo application.
Our Services
-
Odoo API Generation
Integrate and manage Odoo APIs to streamline your business processes.
-
Custom Odoo Development
Tailor Odoo modules and features to fit your specific business needs.
-
Support for Functional Process
Provide ongoing support to optimize your business workflows and functional processes.
-
Maintenance & Migration of Databases
Ensure the smooth operation of your Odoo databases with regular maintenance and migration services.
-
Managing of Odoo on Odoo SH/Clouds
Manage and scale your Odoo instances on Odoo SH or cloud environments effectively.
Support and Assistance
For additional support and assistance, please visit our support channel:
Contact Us
If you have any questions or need further assistance, feel free to contact us:
Email: xbalootsupport@gmail.com
Contact us on WhatsApp
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