使用API密钥验证HTTP请求
项目描述
使用API密钥验证HTTP请求。
API密钥是由调用API的程序在HTTP头中传递(API-KEY)的代码,用于标识调用程序的用户。
在使用此类机制时请谨慎,因为HTTP头中的信息是可见的。因此,仅用于验证来自已知来源的请求。对于未知来源,在代理级别过滤此头信息是一种好的做法。
目录
配置
API密钥菜单在调试模式下可在设置 > 技术中找到。默认情况下,当您创建API密钥时,密钥将保存到数据库中。
如果还安装了server_environment模块,也可以通过配置文件提供此密钥的值。这可以在恢复数据库时避免在您的各种环境中混合密钥非常有用。
您只需按照以下约定在配置文件中添加一个新部分即可
[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上跟踪。如果在那里报告了您的问题,请检查那里。如果您首先发现了它,请通过提供详细且受欢迎的反馈帮助我们解决它。
请勿直接联系贡献者寻求技术支持或帮助。
致谢
贡献者
Denis Robinet <denis.robinet@acsone.eu>
Laurent Mignon <laurent.mignon@acsone.eu>
Quentin Groulard <quentin.groulard@acsone.eu>
Sébastien Beau <sebastien.beau@akretion.com>
维护者
本模块由OCA维护。
OCA,即Odoo社区协会,是一个非营利组织,其使命是支持Odoo特性的协作开发并推广其广泛应用。
本模块是GitHub上OCA/server-auth项目的组成部分。
欢迎您贡献力量。有关详情,请访问https://odoo-community.org/page/Contribute。
项目详情
哈希值 for odoo12_addon_auth_api_key-12.0.3.0.1-py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | cb891e20cf880a08354c09c3e695c641ec21997076170d10e67a726c6ed95e58 |
|
MD5 | 0fc726edec1b568169447e3c53db93a4 |
|
BLAKE2b-256 | d78d8e29c60c0071c41d93c408ba988212a9485573ca05f7cce3fb6c315cc3bb |