按键
更新
密钥通过其token属性在组织级别提供对API的访问。允许代表其组织与所有API端点进行交互。
为每个新创建的组织生成密钥。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
id | 密钥ID | 资源标识符。 |
resource | 字符串，总是key | 资源类型说明符。 |
organisation | 组织ID | 该密钥所属的组织。 |
type | 串 | 其中之一： standard ， trial 。 |
config | 嵌套对象 | 特定于密钥的配置设置。 |
storage_config | 可选的存储配置ID | 密钥使用的存储配置。 |
webhook_config | 可选的webhook配置ID | 密钥使用的webhook配置。 |
token | 串 | 此密钥的auth材料。用于在针对API的请求中填充AUTHORIZATION HTTP标头。 |
state | 串 | 其中之一： active ， deactivated ， blocked ， expired 。 |
date_created | 约会时间 | 资源创建时。 |
date_expires | 可选，日期时间 | 当密钥到期时。主要适用于trial型钥匙。 |
种类
-
standard - 关键类型。每个组织至少有一个这样的组织。
-
trial - API管理员生成的密钥，用于授予组织对其他权限的试用权限。这些通常会设置
date_expires字段。
配置
可以在密钥的config属性上设置密钥级配置。目前只接受publish_source_files ，与源文件发布机制相关。
存储和 webhook 配置
密钥资源可以覆盖存储和webhook配置的组织默认值。这有助于在开发和生产等环境之间拆分结果和事件通知。
代币
密钥的token属性的值可用于代表拥有组织对API进行身份验证。
这些值应安全存储，不得公开曝光。
州
-
active - 钥匙的标准状态。
-
deactivated - 拥有组织已经禁用了密钥。
-
blocked - 密钥已被API管理员禁用。
-
expired - 试用期过后，密钥被禁用。
创建POST /keys
参数
| 姓名 | 类型 | 描述 |
|---|---|---|
storage_config | 存储配置 ID | 覆盖此密钥上组织的默认存储配置。 |
webhook_config | 网络钩子配置 ID | 在此键上覆盖组织的默认 webhook 配置。 |
使用cURL
curl 'https://ricloud-api.reincubate.com/keys' \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "storage_config": 2, }'
使用ricloud-py
import ricloud key = ricloud.Key.create(storage_config=2) # OR storage_config = ricloud.StorageConfig.retrieve(2) key = ricloud.Key.create(storage_config=storage_config)
检索GET /keys/{key ID}
使用cURL
curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \ -H 'Authorization: Token <your key_token>'
使用ricloud-py
import ricloud key = ricloud.Key.retrieve(<key ID>)
列出GET /keys
参数
| 姓名 | 类型 | 描述 |
|---|---|---|
type | 细绳 | 按类型过滤键。 |
state | 细绳 | 按状态过滤键。 |
使用cURL
curl 'https://ricloud-api.reincubate.com/keys?limit=2' \ -H 'Authorization: Token <your key_token>'
使用ricloud-py
import ricloud keys = ricloud.Key.list(limit=2)
更新POST /keys/{key ID}
参数
| 姓名 | 类型 | 描述 |
|---|---|---|
storage_config | 存储配置 ID | 更新密钥使用的存储配置。如果为null将回退到组织默认值。 |
webhook_config | 网络钩子配置 ID | 更新密钥使用的 webhook 配置。如果为null将回退到组织默认值。 |
使用cURL
curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "webhook_config": 2 }'
使用ricloud-py
import ricloud key = ricloud.Key.update_with_id(<key ID>, webhook_config=2) # OR key = ricloud.Key.retrieve(<key ID>) key.update(webhook_config=2)
旋转POST /keys/{key ID}/rotate
旋转键token的值。虽然不是必需的，但建议定期执行此操作，或者如果怀疑密钥的token已被泄露，则立即执行此操作。
参数
| 姓名 | 类型 | 描述 |
|---|---|---|
force | 布尔值，默认值： False | 如果当前token值应立即取消授权。如果不是，则当前轮换周期为调用后 6 小时。 |
使用cURL
curl 'https://ricloud-api.reincubate.com/keys/<key ID>/rotate' \ -X POST \ -H 'Authorization: Token <your key_token>'
使用ricloud-py
import ricloud key = ricloud.Key.rotate_with_id(<key ID>) # OR key = ricloud.Key.retrieve(<key ID>) key.rotate()
