协议

更新

异步处理

API使用异步处理进行所有轮询。这包括与外部服务(例如iCloud)的交互,因为这些可能需要几秒或几分钟才能完成,具体取决于所需的处理量。

许多标准资源交互可以触发API参考文档中概述的异步“副作用”。这些通常用于执行有效性检查或其他实用程序功能。

API的异步基础还有助于简化从API内触发的定期轮询的接口。这意味着无论是直接与API进行交互还是通过预定的民意调查,事件和结果检索都是相同的。

等待回应

该API支持通过长期请求等待异步任务的完成,以最大程度地减少轮询需求并减少最终用户的总响应时间。要启用此功能,请将Ricloud-Await HTTP标头添加到具有所需超时值的请求中。当前的最大超时值为10秒。

Ricloud-Await: 3

以下端点支持此功能:

加密发布

API发布的所有结果都可以使用组织范围的公共RSA密钥进行加密。

属性类型

任何日期时间属性将始终根据ISO8601规范进行格式化。 API使用UTC时区返回所有日期时间属性。因此,预期格式为"2018-08-22T10:25:05Z"

分页

API使用基于游标的分页。所有列表类型调用都采用其他参数:

  • limit以指定要返回的最大项目数。默认值为10,最大值为1000。
  • after_id指定从中开始列出的ID。
  • before_id指定要从中停止列出的资源ID。

列表响应包括data属性下的返回资源。还包括辅助属性has_more ,它表示是否可以列出由于限制而未包括的更多资源。

速率限制

对API的请求可以通过标准速率限制或飞行中请求限制来限制。前者用于最大限度地减少API资源的滥用,而后者用于保护单个资源实例。

速率限制示例:来自单个组织的API请求数量上限为每小时10,000个请求。这有助于防止恶意或意外的流量高峰。

正在进行的限制示例 :如果另一个任务已在处理,则源资源的实例不能为其创建任务。这可以保持会话的完整性,最大限度地减少外部服务的流量

版本

尽管API的主要版本遵循大部分语义版本控制方案(即v1v2v3 ),但是在v3版本的API内完成的任何更改都是按照日历版本控制方案(即2018-11-06 )进行版本控制的。可以为您的组织全局设置版本,也可以通过Ricloud-Version标头为每个请求指定Ricloud-Version

可删除的资源

大多数资源都是不可删除的,这意味着它们只能由拥有组织停用或由API管理员阻止。

我们能帮你什么吗?

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

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

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

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

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