README.rst

REST API for Webhook

This module is base webhooks standard and keep all log that interface

Step to see logs:

1. Go to Settings > Technical > API Configuration > API Logs
2. this table will keep all log that interface '/api/create_data' or '/api/create_update_data'
3. Users can used this table for test API by click 'Update API'

Table of contents

• Usage
• Bug Tracker
• Credits
  • Authors
  • Contributors
  • Maintainers

Usage

Before sending a REST API request to Odoo, an initial call to authenticate the API is necessary. You can achieve this by calling the /web/session/authenticate route.

The authentication format requires a header with Content-type set to application/json, and the body should include:

{
   "jsonrpc": "2.0",
   "method": "call",
   "params": {
      "db": "<db_name>",
      "login": "<username>",
      "password": "<password>"
   }
}

Following successful authentication, you can proceed with five API routes:

1. /api/create_data: This route allows the creation of new data only. The format for creating data should be in the following structure:

   {
      "params": {
         "model": "<model name>",
         "vals": {
            "payload": {
               "field1": "value1",
               ...
            },
            "result_field": ["field1", ...]  # optional
         }
      }
   }

2. /api/create_update_data: This route facilitates updating data. If the data does not exist, it will automatically create it. The format follows that of create_data, but it requires a unique key in the field to update the values.

   {
      "params": {
         "model": "<model name>",
         "vals": {
            "search_key": {
               "<key_field>": "value",  # can be ID or name search string
            },
            "payload": {
               "field1": "value1",
               ...
            },
            "result_field": ["field1", ...]  # optional
         }
      }
   }

3. /api/update_data: This route allows updating existing data, using a unique key in the field to find the desired data and update values in that recordset.

   {
      "params": {
         "model": "<model name>",
         "vals": {
            "search_key": {
               "<key_field>": "value",  # can be ID or name search string
            },
            "payload": {
               "field1": "value1",
               ...
            }
         }
      }
   }

4. /api/search_data: This route allows you to search for the value of a desired field in a model by using a search domain to find the desired recordset. You can also limit and order the resulting data.

   {
      "params": {
         "model": "<model name>",
         "vals": {
            "payload": {
               "search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
               "search_domain": "[('field', 'operator', 'value')]",
               "limit": 1,
               "order": "field1 , field2 desc, ..."
            }
         }
      }
   }

5. /api/call_function: This route allows you to call a function on a model object based on the provided input.

   Parameters:

   • name (str): The name of the model to perform the function on.
   • method (str): The name of the function to call.
   • parameter (dict): A dictionary containing the arguments to pass to the function (if any).

   {
      "params": {
         "model": "<model name>",
         "vals": {
            "search_key": {
               "<key_field>": "value",  # can be ID or name search string
            },
            "payload": {
               "method": "<method>",
               "parameter": {"<key>": "<value>", ...}
            }
         }
      }
   }

Note: If you want to attach a file to a record, you can add the key "attachment_ids" at any level of the payload.

Example Request with Attachment:

{
   "params": {
      "model": "<model name>",
      "vals": {
         "search_key": {
            "<key_field>": "value",  # can be ID or name search string
         },
         "payload": {
            "attachment_ids": [
               {
                  "name": "<file_name>",
                  "datas": "<base64_encoded_data>"
               }
            ],
            ...
         }
      }
   }
}

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• Ecosoft

Contributors

• Kitti Upariphutthiphong <[email protected]>
• Saran Lim. <[email protected]>

Maintainers

This module is part of the ecosoft-odoo/ecosoft-addons project on GitHub.

You are welcome to contribute.