按键

更新

密钥通过其token属性在组织级别提供对API的访问。允许代表其组织与所有API端点进行交互。

为每个新创建的组织生成密钥。

属性

名称类型描述
id 密钥ID 资源标识符。
resource 字符串,总是key 资源类型说明符。
organisation 组织ID 该密钥所属的组织。
type 其中之一: standardtrial
storage_config 可选的存储配置ID 密钥使用的存储配置。
webhook_config 可选的webhook配置ID 密钥使用的webhook配置。
token 此密钥的auth材料。用于在针对API的请求中填充AUTHORIZATION HTTP标头。
state 其中之一: activedeactivatedblockedexpired
date_created 约会时间资源创建时。
date_expires 可选,日期时间当密钥到期时。主要适用于trial型钥匙。

类型

standard
关键类型。每个组织至少有一个这样的组织。
trial
API管理员生成的密钥,用于授予组织对其他权限的试用权限。这些通常会设置date_expires字段。

存储和webhook配置

密钥资源可以覆盖存储和webhook配置的组织默认值。这有助于在开发和生产等环境之间拆分结果和事件通知。

代币

密钥的token属性的值可用于代表拥有组织对API进行身份验证。

这些值应安全存储,不得公开曝光。

active
钥匙的标准状态。
deactivated
拥有组织已经禁用了密钥。
blocked
密钥已被API管理员禁用。
expired
试用期过后,密钥被禁用。

创建POST /keys

参数

名称类型描述
storage_config 存储配置ID 覆盖此密钥上组织的默认存储配置。
webhook_config webhook配置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 webhook配置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 bool,默认值: 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()

我们能帮你什么吗?

我们的支持团队在这里提供帮助!

我们的办公时间是格林威治标准时间周一至周五上午9点至下午5点。 时间目前是 6:09 AM的 GMT。

我们力争在一个工作日内答复所有垂询。

转到支持部分 › 联系企业团队 ›
我们的支持团队非常棒

© 2008 - 2019 Reincubate Ltd. 保留所有权利。 在英格兰和威尔士注册 #5189175, VAT GB151788978. Reincubate®是注册商标。 隐私权和条款. 我们推荐多因素认证。 在伦敦建立了爱情。