$ 86.64
| Required Apps |
•
Discuss (mail)
|
| Community Apps Dependencies |
api_auth_basic
api_cors_config api_auth_jwt api_auth_apikey api_log api_auth_oauth2 api_auth_apiuser api_resource_access jsonapi_studio easy_graphql graphql_studio easy_jsonapi_basic_signup easy_jsonapi_apikey_signup easy_jsonapi restjson_studio easy_restjson api_auth_public api_framework_base ekika_utils ekika_widgets |
| Technical Name |
api_framework
|
| License | OPL-1 |
| Also available in version | 18.0 17.0 16.0 |
api-framework
Odoo API Framework | Build Custom REST & GraphQL APIs
A comprehensive framework for creating powerful and secure RESTful and GraphQL APIs in Odoo. Integrate with any external application with ease and flexibility.
Odoo, API Framework, REST API, GraphQL, Odoo Integration, API Builder, Custom API, Web Services, Developer Tools, API Management
Introduction
The Odoo API Framework is a robust and versatile module that provides a comprehensive toolkit for building custom RESTful and GraphQL APIs directly within your Odoo environment. Designed for developers and businesses that require seamless integration with external systems, this framework simplifies the entire API creation process. It offers a secure, scalable, and feature-rich platform for exposing your Odoo data and business logic to web services, mobile applications, and third-party software. With support for multiple authentication methods and data formats, the Odoo API Framework is the ultimate solution for creating powerful and flexible integrations.
Key Features
Supports multiple API technologies, including REST (JSON:API) and GraphQL, for maximum flexibility.
Provides various secure authentication methods, such as API Key, JWT, and OAuth2.
Enables full CRUD (Create, Read, Update, Delete) operations on any Odoo model, including custom ones.
Allows for the execution of custom Odoo methods and workflows through API calls.
Automatically generates API documentation using standards like OpenAPI (Swagger).
Offers granular access control to manage user permissions for different API endpoints.
Includes features for pagination, filtering, sorting, and grouping of data.
Supports file uploads and downloads, as well as the generation of reports.
Benefits
Accelerate the development of custom integrations with a powerful and easy-to-use framework.
Enhance data security with robust authentication and granular access control mechanisms.
Improve developer productivity with automatically generated API documentation.
Increase the flexibility of your Odoo system by making it accessible to a wide range of external applications.
Streamline business processes by automating data exchange and workflow execution.
Build high-performance and scalable integrations with support for modern API technologies.
Reduce the complexity of Odoo integrations with a no-code/low-code approach to API creation.
Compatibility & Technical Details
License: OPL-1
Technical Name: api_framework
Installation Steps:
Place the module folder and its dependencies into your Odoo addons directory.
Install the required Python libraries as specified in the module's documentation.
Restart the Odoo server.
Navigate to the 'Apps' menu in your Odoo instance.
Click on 'Update Apps List'.
Search for the 'API Framework' module and click 'Install'.
Configure your API endpoints, authentication methods, and access rights from the module's settings.
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.