Webhooks钩子¶
Warning
强烈建议 在决定使用网络钩子时以及在整个实施过程中咨询开发人员、解决方案架构师或其他技术角色。如果配置不当,网络钩子可能会扰乱 Odoo 数据库,并且可能需要较长时间才能恢复。
网络钩子可在 Studio 中创建,是由外部事件通过用户定义的 HTTP 回调触发的自动化规则。当外部系统向 Odoo 网络钩子的 URL(即“触发器”)发送数据文件(即“载荷”)时,Odoo 会在数据库中执行预定义的操作作为响应。
与计划操作或手动 API 调用不同,网络钩子可实现实时通信和自动化。例如,如果外部 POS 系统确认了销售订单,网络钩子可以立即更新 Odoo 的库存,从而确保系统同步。
Note
本文介绍如何创建一个从外部源 接收 数据的网络钩子。不过,也可以创建通过 向外部网络钩子发送 API 调用 的自动化操作。
在 Studio 中创建网络钩子¶
网络钩子在 Studio 中配置,其设置分为 触发器 和 操作 两部分。
Tip
在 Odoo 中设置网络钩子时,如果连接的是 Odoo 数据库,则无需编写代码,但测试需要使用 Postman 之类的外部工具。自定义目标记录或操作 可能需要编程技能。
激活开发者模式 以修改网络钩子所针对的模型(例如销售订单或联系人信息),并查找该模型的技术名称(正确配置载荷时可能需要用到)。
设置网络钩子的触发器¶
要使用 Studio 创建网络钩子,请 打开 Studio ,点击 网络钩子 ,然后点击 新建 。在此处为网络钩子命名,如有需要可修改网络钩子的模型(即要针对的数据库条目的种类),并切换是否应记录对网络钩子 URL 的调用(这会跟踪网络钩子的调用历史,以便排查问题)。
网络钩子的 URL 会自动生成。该 URL 用于测试网络钩子,并将其连接到将向数据库发送更新的外部系统。
Danger
网络钩子的 URL 是 机密 信息,应谨慎处理。在网上或在无防范的情况下分享它,可能会让 Odoo 数据库遭到非预期的访问。如有需要,请点击 轮换密钥 更改 URL。
最后,如果发送网络钩子的系统不是 Odoo,请调整 目标记录 操作,使其在向网络钩子的 URL 发起调用时,查找 API 调用载荷中所含的 JSON 记录。如果发送网络钩子的系统是 Odoo 数据库,请确保 id 和 model 出现在载荷中。
Tip
尽管 模型 是在 Odoo 中设置的,但载荷中必须包含的是模型的技术名称。将鼠标悬停在模型名称上,然后点击 (内部链接) 图标,即可在 模型 字段中找到该技术名称。例如,销售订单网络钩子使用 销售订单 模型,但载荷中使用的是技术名称 sale.order 。
Note
在 Odoo 数据库中创建记录时,不应使用目标记录的默认格式,而应使用 model.browse(i) 或 model.search(i) 。
设置网络钩子的操作¶
配置网络钩子时设置其操作,请在 要执行的操作 选项卡下点击 添加操作 。点击操作的 类型 ,并根据需要设置字段。
测试网络钩子¶
Note
测试网络钩子需要先完成网络钩子的设置,准备好要发送到网络钩子的测试载荷,以及一个通过 POST API 请求发送载荷的外部工具或系统。考虑使用 Postman 之类的工具,这样所需的技术能力较低。
如果在测试中返回 200 OK 或 status: ok 消息,则说明网络钩子在 Odoo 端运行正常。接下来,就可以开始在另一个工具中实施,使用网络钩子的 URL 自动将这些网络钩子调用发送到 Odoo。
如果返回其他响应,响应中携带的数字有助于定位问题。例如,500 Internal Server Error 表示 Odoo 无法正确解析该调用。如果返回此响应,请确保 JSON 文件中包含的字段已正确映射到网络钩子的配置以及发送测试调用的系统中。在网络钩子配置中开启调用日志记录,可在网络钩子未按预期工作时提供错误日志。
实施网络钩子¶
网络钩子配置完成后,就可以开始将其连接到通过该网络钩子向 Odoo 数据库发送数据的系统。在设置该系统时,请确保将 API 调用发送到网络钩子的 URL。
网络钩子用例¶
以下是在 Odoo 中使用网络钩子的两个示例。这些网络钩子需要外部工具(已在示例中列出)。
Warning
在决定实施网络钩子时,请咨询开发人员、解决方案架构师或其他技术角色。如果配置不当,网络钩子可能会扰乱 Odoo 数据库,并且可能需要较长时间才能恢复。
更新销售订单的币种¶
此网络钩子会将 销售 应用中的销售订单更新为 USD。它适用于总部位于美国而子公司在境外的企业,也适用于合并时将数据整合到同一个 Odoo 数据库的场景。
设置网络钩子的触发器¶
要设置此网络钩子,请打开 销售 应用。然后 设置触发器 ,将 模型 设为 Sales Order 。同时,将 目标记录 设为 model.env[payload.get('model')].browse(int(payload.get('id'))) 。下文将逐一说明。
model:在 Odoo 中更新什么(本例中为销售订单)。它与前面设置的 模型 一致。
env:执行操作所在的环境。本例中为 Odoo。
payload:发送到网络钩子 URL 的内容。其中包含用于更新销售订单的信息。
get(‘model’):告诉网络钩子要查看哪条数据库记录。本例中,网络钩子会检索(
get)与特定model关联的数据。在本示例中即销售订单模型。browse:告诉网络钩子在载荷所设置的
model(销售订单)中查找要更新的内容。int:将目标转换为
integer(整数)。如果载荷的目标记录中包含某些单词(string)或小数,这一点很重要。get(‘id’):标识要在 Odoo 中更新的销售订单编号。
设置网络钩子的操作¶
设置触发器后,点击 添加操作 来设置网络钩子的操作。对于 类型 ,点击 更新记录 。然后选择 Update ,选择 Currency 字段,并选择 USD 将币种字段更新为 USD。最后,点击 保存并关闭 。
网络钩子设置摘要¶
总结一下所设置的内容:网络钩子以销售订单为目标,通过销售订单编号进行标识,当向网络钩子的 URL 发送包含该销售订单编号(由载荷中的 id 记录标识)的 POST 请求时,会将其币种更新为 USD 。
测试网络钩子¶
测试网络钩子的设置,确保一切正确。此过程使用名为 Postman 的工具发送模拟触发。
本节将逐步介绍如何在 Postman 中测试此网络钩子,但不会就该工具内部的问题提供帮助。如需 Postman 的专门帮助,请联系其支持团队。
打开 Postman 后,创建一个新的 HTTP 请求,并将其方法设为 POST 。接下来,复制要测试的网络钩子的 URL,并粘贴到 Postman 的 URL 字段中。之后,点击 Body 选项卡并选择 raw 选项。将文件类型设为 JSON ,然后复制这段代码并粘贴到文件中。
{
"model": "sale.order",
"id": "SALES ORDER NUMBER"
}
接下来,选择一张销售订单用来测试网络钩子。如果无法在正式的 Odoo 数据库中测试,可以考虑创建一个演示数据库,其中包含一张示例销售订单以及已配置的网络钩子。将 SALES ORDER NUMBER 替换为销售订单编号,去掉 S 以及编号前面的任何零。例如,编号为 S00007 的销售订单在 Postman 中应输入为 7 。最后,在 Postman 中点击 Send 。
如果返回 200 OK 或 status: ok 消息,则说明网络钩子在 Odoo 端运行正常。测试销售订单的币种已更新。接下来,就可以开始在另一个工具中实施,使用网络钩子的 URL 自动将这些网络钩子调用发送到 Odoo。
如果返回其他响应,与之对应的数字有助于定位问题。例如,500 Internal Server Error 表示 Odoo 无法正确解析该调用。如果返回此响应,请确保 model 和 id 字段已正确映射到网络钩子的配置和 Postman 中。
创建新联系人¶
此网络钩子使用自定义代码在 Odoo 数据库中创建新联系人。这对于自动创建新的供应商或客户很有帮助。
设置网络钩子的触发器¶
要设置此网络钩子,请打开 联系人 应用。然后 设置触发器 ,将 模型 设为 Contact 。同时,将 目标记录 设为 model.browse([2]) 。下文将逐一说明。
model:在 Odoo 中更新什么(本例中为联系人)。它与前面设置的 模型 一致。
browse:告诉网络钩子在载荷所设置的
model(联系人)中查找要创建的内容。
设置网络钩子的操作¶
设置触发器后,点击 添加操作 来设置网络钩子的操作。对于 类型 ,点击 执行代码 ,然后将 代码 设为下面的示例代码。最后,点击 保存并关闭 。
# variables to retrieve and hold data from the payload
contact_name = payload.get('name')
contact_email = payload.get('email')
contact_phone = payload.get('phone')
# a Python function to turn the variables into a contact in Odoo
if contact_name and contact_email:
new_partner = env['res.partner'].create({
'name': contact_name,
'email': contact_email,
'phone': contact_phone,
'company_type':'person',
'customer_rank': 1,
})
# an error message for missing required data in the payload
else:
raise ValueError("Missing required fields: 'name' and 'email'")
网络钩子设置摘要¶
总结一下所设置的内容:当向网络钩子的 URL 发送包含联系人信息的 API 调用时,该网络钩子会创建联系人。
测试网络钩子¶
测试网络钩子的设置,确保一切正确。此过程使用名为 Postman 的工具发送模拟触发。
本节将逐步介绍如何在 Postman 中测试此网络钩子,但不会就该工具内部的问题提供帮助。如需 Postman 的专门帮助,请联系其支持团队。
打开 Postman 后,创建一个新的请求,并将其方法设为 POST 。接下来,复制要测试的网络钩子的 URL,并粘贴到 Postman 的 URL 字段中。之后,点击 Body 选项卡并点击 raw 。将文件类型设为 JSON ,然后复制这段代码并粘贴到文件中。
{
"name": "CONTACT NAME",
"email": "CONTACTEMAIL@EMAIL.COM",
"phone": "CONTACT PHONE NUMBER"
}
在 Postman 中将上述字段替换为新联系人的信息,然后点击 Send 。
如果返回 200 OK 或 status: ok 消息,则说明网络钩子在 Odoo 端运行正常。新的测试联系人会出现在 联系人 应用中。接下来,就可以开始在另一个工具中实施,使用网络钩子的 URL 自动将这些网络钩子调用发送到 Odoo。
如果返回其他响应,与之对应的数字有助于定位问题。例如,500 Internal Server Error 表示 Odoo 无法正确解析该调用。如果返回此响应,请确保 JSON 文件中包含的字段已正确映射到网络钩子的配置和 Postman 中。