Odoo中的RPC调用

odoo原生支持外部系统调用，通过XMLRPC服务对外提供接口，本章将介绍如何在外部系统中使用RPC接口对odoo进行调用。

XML-RPC

XML-RPC是什么

xmlrpc是一种远程过程调用方法，使用http协议传递xml格式的数据，客户端可以在远程服务器上调用带参数的方法获取结构化的数据。

XML-RPC和Webservice是什么关系？

Webservice是一种抽象的概念描述，具体的实现方式可以有多种，例如REST\SOAP\XML-RPC。SOAP是在XML-RPC的基础上加入了新的功能发展而来的。

Odoo中的XML-RPC

odoo中内置了XML-RPC接口，可以在原生系统中直接调用。

XML-RPC中切换公司

默认情况下，XML-RPC只能工作在默认的公司下，当操作其他公司的对象时就会出现权限问题。此时我们希望使用with_company解决这个问题，但是XML-RPC中的使用方式与Python后端的代码中有所不同。

import xmlrpc.client

url = "http://odoomommy.com"

common = xmlrpc.client.ServerProxy('{}/xmlrpc/2/common'.format(url))
common.version()

uid = common.authenticate("odoo", "admin", "admin_1234", {})

models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
models.execute_kw("odoo", uid, "admin_1234", 'product.template', 'write', [[15327], {
    'standard_price': "678"
}])

models.execute_kw("odoo", uid, "admin_1234", 'product.template', 'write', [[15327], {
    'standard_price': "789"
}], {'context': {'with_company': 2}})

我们要切换公司的时候需要把参数传入到context参数中。

同样地，如果我们希望查询到某条被归档的数据，那么我们可以使用下面的方式进行查询：

product_templates = models.execute_kw(db,user_id,password,'product.template','search',[[('default_code','=','NZMKCGKG23')]],{
    'context':{
        'active_test': False
    }
})

JsonRPC

不止于XML-RPC, odoo原生还支持了JSONRPC的方式进行远程调用。下面我们看一下如何使用Json-RPC进行远程调用。

登录

data='{
    "jsonrpc": "2.0",
    "method": "call",
    "params": {
        "service": "common",
        "method": "authenticate",
        "args": [
            "erp",
            "admin",
            "HkGTVrq4pQzKhRN",
            {}
        ]
    }
}'

curl https://erp.hhglobal.co.nz/jsonrpc -H "Content-Type:application/json" -d $data

---------------
{"jsonrpc": "2.0", "id": null, "result": 2}

搜索

data='{
    "jsonrpc": "2.0",
    "method": "call",
    "params": {
        "service": "object",
        "method": "execute",
        "args": [
            "erp",
            2,
            "password",
            "product.category",
            "search",
            []
        ]
    }
}'
curl https://erp.hhglobal.co.nz/jsonrpc -H "Content-Type:application/json" -d $data

-------------
{"jsonrpc": "2.0", "id": null, "result": [1, 29, 30, 35, 43, 36, 10, 38, 15, 56, 17, 61, 16, 9, 39, 70, 3, 34, 45, 14, 42, 76, 27, 64, 62, 13, 11, 18, 21, 22, 24, 23, 19, 66, 41, 2, 57, 65, 31, 67, 33, 32, 72]}

OdooRPC

第三方库OdooRPC是一个利用jsonrpc实现的远程调用库.

安装方法:

pip install odoorpc

使用方法:

# 使用账号密码登录
odoo = odoorpc.ODOO(host=HOST,port=PORT)
odoo.login(DB,USER,PASSWORD)

#初始化对象
sale_obj = odoo.env['sale.order']
order_ids = sale_obj.search([])

order = sale_obj.browse(order_ids)
orders.write({"price":213.0})

需要注意的是, 这里的search方法返回的结果是记录的ids而不是记录集。

odoorpc给我们提供一种外部脚本化的操作方式, 其中一个有效的场景就是在不同的odoo版本间进行数据迁移. 笔者提供不同版本间的基础数据的迁移服务, 有需要的同学可以联系笔者洽谈.

JSON-2 API

Odoo 19.0中引入了新的外部接口规范: JSON-2 API。

它和旧的XML-RPC/JSONRPC相比有几个明显差异:

  1. 调用入口从/xmlrpc/2/object或/jsonrpc变成了/json/2/<model>/<method>。
  2. 认证方式从uid + password改成了API Key(Bearer Token)。
  3. 参数全部使用具名JSON参数，不再传位置参数。
  4. 返回值更贴近HTTP语义: 成功通常是200，失败是4xx/5xx并返回错误对象。

调用格式

JSON-2 API通过HTTP POST调用，URL结构如下:

/json/2/<model>/<method>

例如读取客户模型中的数据:

/json/2/res.partner/search_read

常用请求头:

Authorization: bearer <API_KEY>
Content-Type: application/json
X-Odoo-Database: <db_name>   # 多数据库场景下建议传入
User-Agent: <your-app-name>

API Key配置

在Odoo用户界面中可以为用户生成API Key(路径通常为: Preferences -> Account Security -> New API Key)。

建议:

  1. 集成场景使用专用机器人账号，不要直接使用管理员个人账号。
  2. API Key只显示一次，生成后立即进入密钥管理系统。
  3. 定期轮换Key，泄露后立即废弃。

请求参数规则

请求体是一个JSON对象，常见字段如下:

  1. ids: 记录ID列表；调用@api.model方法时可以省略。
  2. context: 上下文，例如语言、公司、时区等。
  3. 其他字段: 作为目标方法的命名参数传入。

示例中的search_read方法可以直接传domain、fields、limit等参数。

示例: 使用curl查询客户

data='{
    "context": {
        "lang": "zh_CN"
    },
    "domain": [
        ["is_company", "=", true],
        ["name", "ilike", "tech"]
    ],
    "fields": ["name", "email"],
    "limit": 5
}'

curl https://mycompany.example.com/json/2/res.partner/search_read \
    -H "Authorization: bearer ${ODOO_API_KEY}" \
    -H "Content-Type: application/json" \
    -H "X-Odoo-Database: mycompany" \
    -d "$data"

返回结果是标准JSON数组，例如:

[
    {
        "id": 25,
        "name": "Tech Partner",
        "email": "contact@example.com"
    }
]

示例: Python调用

import requests

BASE_URL = "https://mycompany.example.com/json/2"
API_KEY = "<your_api_key>"

headers = {
        "Authorization": f"bearer {API_KEY}",
        "Content-Type": "application/json",
        "X-Odoo-Database": "mycompany",
        "User-Agent": "odoo-integration-script/1.0",
}

resp = requests.post(
        f"{BASE_URL}/res.partner/search_read",
        headers=headers,
        json={
                "context": {"lang": "zh_CN"},
                "domain": [["is_company", "=", True]],
                "fields": ["name", "email"],
                "limit": 10,
        },
        timeout=30,
)

resp.raise_for_status()
partners = resp.json()
print(partners)

事务与并发注意事项

JSON-2 API的每一次调用都在独立事务中执行:

  1. 调用成功: 事务提交。
  2. 调用失败: 事务回滚。

这意味着把业务拆成多次调用时会有并发风险。例如先search再read，中间记录可能被其他事务修改或删除。

最佳实践是优先使用单次原子方法，例如search_read，或者在自定义模块中封装一个业务方法，让外部只调用一次。

从旧RPC迁移到JSON-2的建议

如果你现有系统在使用execute_kw，迁移时可以按下面步骤进行:

  1. 把db/uid/password鉴权逻辑替换为Authorization: bearer <API_KEY>。
  2. 把model、method移动到URL路径中。
  3. 把原来的args/kwargs改为JSON对象中的命名字段。
  4. 保留context语义(例如lang、allowed_company_ids、active_test)。
  5. 在客户端显式处理HTTP状态码与错误JSON，补齐重试与告警。

官方文档已说明: /xmlrpc、/xmlrpc/2、/jsonrpc计划在Odoo 22中移除，建议新项目直接使用JSON-2 API，老项目尽早完成迁移。

results matching ""

    No results matching ""