跳转到主要内容

使用API密钥验证HTTP请求

项目描述

Beta License: LGPL-3 OCA/server-auth Translate me on Weblate Try me on Runbot

使用API密钥验证HTTP请求。

API密钥是程序在调用API时传递的代码(在http头部API-KEY中),以便识别调用程序的用户。

在使用这种机制时请小心,因为http头部中的信息是可见的。因此,仅用于验证来自已知源头的请求。对于未知来源,在代理级别过滤此头部是一个好的实践。

目录

配置

API密钥菜单在调试模式下可用,位于设置 > 技术中。默认情况下,创建API密钥时,该密钥将保存到数据库中。也可以通过配置文件提供此密钥的值。这在恢复数据库时非常有用,可以避免在不同环境中混合密钥。您只需根据以下约定在配置文件中添加一个新部分即可

[api_key_<Record Name>]
key=my_api_key

用法

要将此认证系统应用于您的http请求,您必须将‘api_key’设置为控制器中路由定义的‘auth’参数的值。

class MyController(Controller):

    @route('/my_service', auth='api_key', ...)
    def my_service(self, *args, **kwargs):
        pass

错误跟踪器

错误在GitHub Issues上跟踪 GitHub Issues。如果遇到问题,请检查是否已报告您的问题。如果您是第一个发现的,请帮助我们通过提供详细的和受欢迎的 反馈

请勿直接联系贡献者以获取技术支持或帮助。

致谢

作者

  • ACSONE SA/NV

贡献者

维护者

此模块由OCA维护。

Odoo Community Association

OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛使用。

此模块是GitHub上OCA/server-auth项目的一部分:OCA/server-auth

欢迎您贡献。要了解如何贡献,请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

此版本没有提供源代码分发文件。请参阅生成分发存档的教程

构建分发

odoo13_addon_auth_api_key-13.0.1.1.1-py3-none-any.whl (28.3 kB 查看哈希值)

上传时间: Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面