Step 1: Add a New Parameter in the Odoo.conf File

Before installing the module, Add "server_wide_modules = web, base, rest_api_odoo" to odoo.conf file. This configuration enables the server to handle requests without requiring database selection. Once this is done, you can proceed to install the module.
Note: If you need to uninstall the module, ensure you remove this parameter from the configuration file.

Step 2: Locate the Postman collections in the provided app folder.

In the extracted module folder, locate the Postman collections file in JSON format.

Step 3: Open Postman and click the Import button.

Step 4: Select the JSON file from the module folder to import the collection.

Imported collections.

Step 5:Open Authentication.

Step 6: Update the Base URL, db (Database Name), login (Database Username) and password (Database Password) under Headers.

Step 7: Click Send.

If authentication is successful, an API key will be generated for the current user.

API Key in the User's Form View

To find the generated API Key for the current user, navigate to Settings > Users & Companies > Users, open the user's form view, and go to the API tab. The API Key will be displayed there.

Step 8: Create Rest API Records.

Navigate to Rest API in Rest API module and create new record. Select the model and the HTTP methods. The chosen methods will determine the allowed actions on the records, and the API response will reflect the changes made.

Step 9: Getting Records via REST API

Open Get records api collection in postman and add the db, login, password, api-key in the headers. Pass the model (e.g., product.template) in the URL to retrieve records for that model.
Note: Make sure that GET method is enabled for product.template model in Rest API record.

Step 10: Specify the fields you want to retrieve in the JSON data under Body section and click Send.

The retrieved records.

Step 11: Get a specific record.

To retrieve a specific record, pass the ID in the URL (e.g., http://localhost:8027/send_request?model=product.template&Id=28) and click Send.

Retrieved record.

Step 12: Creating Records via POST Method

Open Create Records from Rest API Collection. Add db, api-key, login and password under Headers. Update the Base Url.

Step 13: Provide the JSON data under the Body section and specify the model in the URL. Click Send.

Note: Make sure that POST method is enabled for the selected model in Rest API record.

Created Record.

Step 14: Update Records Using PUT.

Open Update Records from Rest API Collection. Add db, api-key, login and password under Headers. Update the Base Url. Note: Make sure that PUT method is enabled for the selected model in Rest API record.

Step 15: Provide the JSON data under the Body section and specify the model in the URL. Click Send.

Response after record update.

Step 16: Delete Records Using DELETE.

Open Delete Records from Rest API Collection. Add db, api-key, login and password under Headers. Update the Base Url. Add the model and the id of the record to delete and click Send. Note: Make sure that DELETE method is enabled for the selected model in Rest API record.

Response after deleting the record.