User Manual of Odoo REST API

Introduction

Odoo REST API offers secure access to application resources through user authentication tokens. These tokens can be generated using Base64-encoded credentials in tools like Postman.

Odoo REST API allows you to define specific access rights and privileges for each user or API key. Responses can be formatted in either JSON or XML, based on user preference.

Additionally, users can retrieve database table schemas through this API.

Features

Protect your API using secure tokens, verifying user identity before allowing access.
User can set the API validity and Throttling limit for an API.
Easily create authentication tokens from the user’s profile without extra setup.
Test your API endpoints directly in the browser using Open API tools for quick validation.
Create API keys with defined rules and limits to control what data or actions are allowed.
Perform all key operations like retrieving, creating, updating, or deleting data using standard HTTP methods.
Select your preferred output format for API responses — either JSON or XML — for smooth integration.
Use the API to check and access your database’s table structure when needed.
Secure your login and token process by encoding credentials in Base64 format.
One API key can be used safely across different users while still maintaining security.
Receive clear messages about permission issues or access limits directly in the API response.

Installation

1. Once you purchase the App from Webkul store, you will receive the link to download the zip file of the module.

2. Extract the file on your system after the download finishes. You will be able to see a folder named- ‘odoo_REST.’

3. Copy and paste this folder inside your Odoo Add-Ons path.

4. Now, open Odoo App and click on the Settings menu. Here, click on Activate Developer Mode.

5. Then, open the Apps menu and click on ‘Update Modules List.’

6. In the search bar, remove all the filters and search ‘odoo_REST.’

7. You will be able to see the module in the search results. Click on ‘Install’ to install it

Workflow

Under Settings >> Technical menu >> Web Service Account

1. Now, generate an API Secret Key and enable User Authentication. Also, select ‘Available for’ option. By enabling Advanced Feature, users can set APIs Validity and Throatling Limits.

Next, generate an API Secret Key, along with enabling ‘User Authentication’. Also, select the ‘Available for’ option.

2. Select ‘users’ under ‘Users & Companies.’ >> Choose ‘API Key’ and click ‘Generate Token’ button to create a token for that specific API within User Authentication’ tab.

3. After that, move back to API key >> User icon/option. This will open a list of users, and their user authentication token will be shown next to their User ID.

5. You can also configure the API key for specific access. Choose the ‘Specific Resources’ option in the ‘Available for’ option, and configure them.

You can also perform User Authentication from Open API.

All you do is encode the login credentials from Base64 in the given format and follow the screenshot instructions. {‘login’:’admin’,’ password’:’admin’}.