ricloud-py客户端实现

更新

ricloud-py客户端是ricloud v3 API接口的简单实现。它还包括一些常见用例的示例实现,以及从第三方存储桶(AWS S3和Google云存储)中检索数据的一些基本实现。

安装

获取客户端的最简单方法是从PyPi安装它。

pip install ricloud==3.0.0

您还可以从GitHub仓库获取代码。

组态

需要key_token来对API进行身份验证。如果您是现有客户,请联系企业支持以获取ricloud v3 API的试用密钥。

ricloud-py可以通过两种方式配置:

  • 通过导入的ricloud模块上的token属性。
import ricloud

ricloud.token = '<your key_token>'
  • 使用以下内容在主目录中创建.ricloud.ini文件。
[api]
token = <you key_token>

有关更多详细信息,请参阅.ricloud.ini文件参考

用法

客户端公开每个API资源的类和一组与它们交互的方法。

>>> import ricloud

>>> org = ricloud.Organisation.retrieve()

>>> print(org.name)
My Organisation

>>> org.update(name='Changed Organisation')

>>> print(org.name)
Changed Organisation

示例实现

客户端包括许多常见交互的示例实现。

这些可以通过samples命令访问

iCloud的

iCloud示例实现提供了一种通过命令行从iCloud帐户检索数据的快速方法。

重新孵化接力

重新孵化中继服务示例实现了创建会话,设置订阅和手动触发轮询所需的一组命令。

Webhook端点

客户端包括一个简单的webhook端点实现,该实现侦听传入的API事件通知并将信息打印到控制台。

建议使用ngrok之类的实用程序将本地终结点安全地暴露给Internet。默认情况下,webhook端点绑定到计算机上的端口8080。

ngrok http -bind-tls=true 8080

您可以在“ Forwarding行中看到您公开的ngrok端点的地址,例如https://abcd1234.ngrok.io

然后,您可以通过运行ricloud event listen命令来启动侦听器。如果客户端配置正确,它将使用命令中指定的URL自动创建一个webhook配置,并将其设置为当前使用的密钥的默认webhook配置。

ricloud event listen --webhook-url https://abcd1234.ngrok.io

.ricloud.ini文件参考

部分: api

token

用于对API的端点进行身份验证的令牌。

url

API的基本URL。默认值: https://ricloud-api.reincubate.comhttps://ricloud-api.reincubate.com

max_retries

如果由于服务器或连接错误导致请求失败,则重试请求的次数。默认值: 3

await_for

将具有指定值的Ricloud-Await标头添加到启用到等待响应机制中。默认值: 0

部分: webhooks

secret

验证传入事件通知有效负载时使用的webhook配置密码。如果对ricloud event listen命令使用--webhook-url选项, ricloud event listen自动设置此设置。

delta

发送事件与接收事件之间的差异(以秒为单位)。默认值: 600

部分: logging

log_level

部分: samples

output_directory

作为示例脚本的一部分下载的任何结果的默认输出目录。如果目录路径是相对路径,则将相对于当前工作目录创建目录路径。

user_identifier

客户端将在执行示例脚本时创建用户资源。此用户标识符的默认值为ricloud-py ,但可以通过此选项轻松自定义。

例如,这可以用于区分同一组织内不同开发人员之间的使用情况。

[api]
token = <your key_token>
url = https://ricloud-api.reincubate.com
max_retries = 1

[logging]
log_directory = logs
log_level = WARNING

[samples]
output_directory = output
user_identifier = ricloud-py

我们能帮你什么吗?

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

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

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

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

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