跳转到主要内容

cone token api

项目描述

Latest PyPI version Number of PyPI downloads Package build https://coveralls.io/repos/github/bluedynamics/cone.tokens/badge.svg?branch=master

此软件包为cone.app提供唯一的令牌生成器。

特性

  • 二维码生成

  • 令牌管理的JSON API

应用ini文件配置

  • cone.tokens.config_file: 必需。令牌json配置文件的路径。

  • cone.tokens.settings_node_path: 可选。令牌设置节点的应用节点路径。

  • cone.tokens.entryfactory: 可选。用作入口节点工厂的节点类。

JSON API

cone.tokens提供了一个用于令牌管理的JSON API。

query_token

通过值查询令牌。它期望一个GET请求。

模式: URL/tokens/query_token

参数

  • value: 包含要查找的令牌值的字符串。

响应

  • success: True或False。

  • token: 令牌数据或不存在时为null。

  • message: 在失败时返回错误消息。

add_token

add_token用于生成新的令牌。它期望一个POST请求。

模式: URL/tokens/add_token

参数

  • value: 包含令牌值的字符串。如果为空,则使用令牌uuid作为值。

  • valid_from: isoformat格式的日期时间。如果为空,则令牌没有生效日期。

  • valid_to: isoformat格式的日期时间。如果为空,则令牌没有过期日期。

  • usage_count:一个整数,定义了令牌可以被消费的次数。如果为-1,则令牌可以被无限次消费。

  • lock_time:令牌消费后锁定的时间(以秒为单位)的整数。

响应

  • success: True或False。

  • token_uid:成功时返回令牌的uid。

  • message: 在失败时返回错误消息。

consume_token

consume_token 用于消费令牌。它期望一个 GET 请求。

模式:URL/tokens/<UUID>/consume_token

参数

  • 不期望任何参数。

响应

  • success: True或False。

  • consumed:成功时表示令牌消费是否有效。

  • message: 在失败时返回错误消息。

update_token

edit_token 用于编辑令牌。它期望一个 POST 请求。

模式:URL/tokens/<UUID>/update_token

参数

  • value:包含令牌值的字符串。如果为空,则使用令牌uuid作为值。如果省略参数,则保持不变。

  • valid_from:isoformat格式的日期时间。如果为空,则令牌没有生效日期。如果省略参数,则保持不变。

  • valid_to:isoformat格式的日期时间。如果为空,则令牌没有过期日期。如果省略参数,则保持不变。

  • usage_count:一个整数,定义了令牌可以被消费的次数。如果为-1,则令牌可以被无限次消费。如果省略参数,则保持不变。

  • lock_time:令牌消费后锁定的时间(以秒为单位)的整数。如果省略参数,则保持不变。

响应

  • success: True或False。

  • message: 在失败时返回错误消息。

delete_token

delete_token 用于删除令牌。它期望一个 POST 请求。

模式:URL/tokens/<UUID>/delete_token

参数

  • 不期望任何参数。

响应

  • success: True或False。

  • message: 在失败时返回错误消息。

待办事项

  • 为JSON API引入 consume 权限。

贡献者

  • Robert Niederreiter

  • Torben Baumgartner

  • Lena Daxenbichler

变更

0.5 (2024-05-23)

  • 更新Makefile。[rnix]

  • cone.tokens.model.Tokenspropertiesmetadata 现在是实例属性。[rnix]

  • 使用 ts.http_request 而不是 ts.ajax.request。[rnix]

0.4 (2024-02-12)

  • 采用来自 cone.app 的设置UI更改。[rnix]

0.3 (2023-09-28)

  • 可以批量删除令牌。[lenadax]

  • 可以从扫描的值创建令牌。[rnix]

0.2 (2023-09-27)

  • 实际上将包上传到pypi。[rnix]

0.1 (2023-09-27)

  • 初始工作。[rnix, toalba, lenadax]

许可证

MIT许可证

版权所有 (c) 2023-2024,Cone贡献者

特此授予任何获得此软件及其相关文档副本(“软件”)的人免费使用权,不受任何限制,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利,并允许向软件提供方提供软件的人这样做,但受以下条件约束

上述版权声明和本许可声明应包含在软件的任何副本或实质性部分的副本中。

软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于对适销性、适用于特定目的和无侵犯性的保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论此类索赔、损害或其他责任是基于合同、侵权或其他方式产生的,与软件或其使用或其它有关。

项目详情


下载文件

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

源分布

cone_tokens-0.5.tar.gz (30.7 kB 查看哈希值)

上传时间:

构建分布

cone.tokens-0.5-py3-none-any.whl (40.7 kB 查看哈希值)

上传时间: Python 3

支持者