【odoo | XML-RPC】odoo外部API解读，实现跨系统间的通讯！

概要

        文章注意对官方的XML-RPC进行解读实操，以python为例，给大家介绍其使用方式和调用方法。

内容

什么是odoo的外部API?

Odoo 的外部 API 是一种允许外部应用程序与 Odoo 实例进行交互的接口。通过 API，可以执行各种操作，例如读取、创建、更新和删除 Odoo 中的数据。

为什么叫XML-RPC？

XML-RPC（Extensible Markup Language Remote Procedure Call）：一种基于 XML 和 HTTP 的协议，用于调用远程服务器上的方法。

odoo外部API密钥是什么?

Odoo 外部 API 密钥是一种授权机制，用于替代传统的用户名和密码认证。API 密钥是一串唯一的字符串，授予给开发者或应用程序，以便安全地访问 Odoo 的外部 API。API 密钥在 Odoo 14 版本及更高版本中引入，旨在简化和增强 API 认证的安全性。

为什么使用API密钥？

• 安全性：

  • API 密钥比用户名和密码更安全，因为它们通常具有更高的复杂性和随机性。
  • 密钥的使用可以限制权限和范围，从而减少潜在的安全风险。
  • 可以单独管理和撤销密钥，而无需更改用户密码，这在应对安全事件时非常有用。

• 简化认证：

  • 使用 API 密钥进行认证比传统的用户名和密码认证更简单。开发者只需在请求中包含密钥即可。
  • 密钥可以为特定的应用程序生成，避免共享用户的个人密码。

• 审计和管理：

  • 可以对不同的应用程序或用户分配不同的 API 密钥，从而更容易跟踪和管理每个密钥的使用情况。
  • 在发现密钥泄露或不当使用时，可以单独撤销或更换密钥，而不影响其他用户或应用程序的正常操作。

如何设置密钥？ 

记住：一定要拷贝好这个密钥，否则无法找回 ，只能重新设置新密钥！！！

调用方法（增删改查）

import xmlrpc.client # 不同开发语言可能有不同的SDK，其他语言可查看官方文档https://www.odoo.com/documentation/17.0/developer/reference/external_api.html

url = 'http://127.0.0.1:8069'
db = 'csdn_module_1'
username = 'admin'
password = '1' # 密码或者密钥（b9063d9993bbcc5cbddbb808dd4afb7044e74cd1）【密钥是14.0 版本中开始的新功能】

# 登录
common = xmlrpc.client.ServerProxy('{}/xmlrpc/2/common'.format(url))
common.version()
uid = common.authenticate(db, username, password, {}) # 拿到uid保存好，后面调用其他接口需要用到

# 增 ################################################################################################################################################


import xmlrpc.client

url = 'http://127.0.0.1:8069'
db = 'csdn_module_1'
username = 'admin'
password = '1'
uid = 2 # 登录获取到的uid

# 创建数据
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
# 以下我将创建一条联系人数据：名为"新新东方厨师"，销售员为id为2的用户，同时创建3条子联系人数据。【注：在一对多或者多对多字段更改中，应遵循以下规则
# {
#     'name': 'Order 1',
#     'order_line': [
#         (0, 0, {'product_id': 1, 'quantity': 10}),    # 创建新记录
#         (1, 42, {'quantity': 20}),                    # 更新 ID 为 42 的记录
#         (2, 43, False),                               # 删除 ID 为 43 的记录
#         (3, 44, False),                               # 解除与 ID 为 44 的记录的关联
#         (4, 45, False),                               # 将 ID 为 45 的记录添加到关联中
#         (5, 0, 0),                                    # 清空所有关联记录
#         (6, 0, [46, 47])                              # 用 ID 为 46 和 47 的记录替换所有现有记录
#     ]
# }】
result = models.execute_kw(db, uid, password, 'res.partner', 'create', [
    {
        'name': "新新东方厨师",
        'user_id':2,
        'child_ids': [
            (0, 0, {'name': '新新东方厨师1'}),
            (0, 0, {'name': '新新东方厨师2'}),
            (0, 0, {'name': '新新东方厨师3'}),
        ]
    }
])
# result返回新纪录的id则成功创建！
# 删 ################################################################################################################################################


import xmlrpc.client

url = 'http://127.0.0.1:8069'
db = 'csdn_module_1'
username = 'admin'
password = '1'
uid = 2 # 登录获取到的uid

# 删除数据
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
# 以下我将删除id为43的记录，多条记录则[1,2,3,6]
result = models.execute_kw(db, uid, password, 'res.partner', 'unlink', [[43]])
# result返回True则删除成功，如验证也可查询验证！
# 改 ################################################################################################################################################


import xmlrpc.client

url = 'http://127.0.0.1:8069'
db = 'csdn_module_1'
username = 'admin'
password = '1'
uid = 2 # 登录获取到的uid

# 改数据
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
# 以下我将更改id为46的数据，改名为"新新东方厨师2"，并且把销售员改为id为8的用户，同时创建了3条子联系人数据。【注：在一对多或者多对多字段更改中，应遵循以下规则
# {
#     'name': 'Order 1',
#     'order_line': [
#         (0, 0, {'product_id': 1, 'quantity': 10}),    # 创建新记录
#         (1, 42, {'quantity': 20}),                    # 更新 ID 为 42 的记录
#         (2, 43, False),                               # 删除 ID 为 43 的记录
#         (3, 44, False),                               # 解除与 ID 为 44 的记录的关联
#         (4, 45, False),                               # 将 ID 为 45 的记录添加到关联中
#         (5, 0, 0),                                    # 清空所有关联记录
#         (6, 0, [46, 47])                              # 用 ID 为 46 和 47 的记录替换所有现有记录
#     ]
# }】
result = models.execute_kw(db, uid, password, 'res.partner', 'write', [
    [46],
    {
        'name': "新新东方厨师2",
        'user_id': 8,
        'child_ids': [
            (0, 0, {'name': '新新东方厨师4'}),
            (0, 0, {'name': '新新东方厨师5'}),
            (0, 0, {'name': '新新东方厨师6'}),
        ]
    }
])
# result返回True则更改成功，如验证也可查询验证！
# 查 ################################################################################################################################################


import xmlrpc.client

url = 'http://127.0.0.1:8069'
db = 'csdn_module_1'
username = 'admin'
password = '1'
uid = 2 # 登录获取到的uid

# 查询数据
models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))

## 以下我将查询id为43的记录/查询符合条件的记录集,offset为数据开始索引值（0开始），limit为数据条数
result = models.execute_kw(db, uid, password, 'res.partner', 'search',
       [[
           ['is_company', '=', False],
           ['id', '=', 44]
       ]],
       {
           'offset': 0,
           'limit': 1
       }
   )
## result返回id记录集[44]则成功查询！

## 以下我将查询id记录集为[44,50]数据，并只需要返回字段id,name,country_id三个。
result2 = models.execute_kw(db, uid, password, 'res.partner', 'read',
        [[44,50]],
        {
            'fields': ['id', 'name', 'country_id']
        }
    )
## result2返回列表[{'id': 44, 'name': '小明', 'country_id': False}, {'id': 50, 'name': '小白', 'country_id': False}]则成功查询！

小结

        多写多敲多思考，毕竟，知己知彼才能看懂源码。

Tip：本人才学尚浅，如有纰漏，还请不吝赐教！