Introduction

The Odoo REST API module enables seamless integration between Odoo and external platforms like mobile apps, websites, or third-party systems. It supports full CRUD operations on Odoo models using token-based authentication for secure access. Admins can generate and manage API keys, configure user authentication, and define fine-grained access rights for specific models or all resources. The module includes advanced features like throttling, key validity, and scoped access control (per model and operation). A dedicated User Authentication tab in the user profile allows generating login tokens for individual APIs. It offers developer-friendly OpenAPI (Swagger UI) and Postman Collection documentation for interactive API testing. All endpoints follow standard REST methods (GET, POST, PUT, DELETE) and respect Odoo's permission system.

REST API in Odoo!

The Odoo REST API module allows secure and flexible integration between Odoo and external platforms such as websites, mobile apps, or third-party tools.

It supports full CRUD operations (Create, Read, Update, Delete) through HTTP methods like GET, POST, PUT, and DELETE. Using API keys and user tokens, it ensures safe access to Odoo resources.

This module provides:

  • Token-based authentication
  • API key generation and access control
  • OpenAPI (Swagger) and Postman Collection documentation
  • Easy configuration and developer-friendly design
  • Support for both all and specific Odoo models

It's ideal for connecting Odoo with any modern system, offering fine-grained control, secure data access, and real-time integration capabilities.

Purpose of REST API in Odoo

The Odoo REST API is a powerful tool that works independently of the Odoo interface. It enables integration with external applications, supports process customization, and allows for dynamic interaction with Odoo data. Below are some specific purposes of using the Odoo REST API:

  • Reduces manual workload and minimizes the risk of human error, increasing operational efficiency.
  • Enables fine-grained control over records using different HTTP methods like GET, POST, PUT, and DELETE.

User Authentication for REST API

The module supports user authentication to secure REST API operations in Odoo. User authentication plays a crucial role in identifying who is making the API request, the purpose behind it, and what level of access they are permitted. By introducing a strong validation layer, it ensures that only authorized users can access or manipulate the data through the API. This security mechanism not only protects sensitive business records but also helps in tracking API usage per user, ensuring transparency and accountability. Additionally, it helps prevent unauthorized access, data breaches, and other security risks such as fraud or tampering. In essence, user authentication strengthens the safety and control of REST API interactions within Odoo.

Creating API for All resources along with user authentication

Generate API Key

Generate X-Login-Token

Generate X-Login-Token