概观

这是Reincubate的ricloud API的文档。该API允许用户通过Reincubate Relay应用程序访问Apple的iCloud和本地iTunes备份中自己的数据。

有关产品信息，请参阅ricloud API产品页面 。

关键概念

资源

该API被组织为一组资源。客户端可以创建，检索，更新和销毁（CRUD）这些内容，以配置，触发和监视API上的操作。有关更多详细信息，请参见API资源参考 。

异步处理

API依赖于异步操作来设置针对第三方服务和数据处理的会话。这使其能够在负责任地与外部服务交互的同时管理大量数据需求。它还提供了额外的灵活性，以应对响应时间的波动或来自第三方的服务降级。

存储桶发布

从API请求的数据将直接发布到Google云端存储或Amazon S3上的客户端存储桶中。这有助于最大限度地减少与扩展数据交付相关的问题，并且还可以加快数据检索速度，因为发布不太可能成为瓶颈。

Webhook通知

异步操作完成的通知是通过webhooks处理的，事件通过标准的HTTP请求发送到客户端的服务器。这些事件包含有关在客户端的存储桶中何处查找请求的数据的信息，从而使客户端可以决定何时以及如何使用它。

关键术语

在深入了解入门部分之前，熟悉将在整个过程中使用的一些术语和概念是有帮助的。

服务

服务描述了通过API可用的数据源集合。这包括第三方服务，如iCloud或Reincubate产品，如asrelay 。

不同的服务对API上的某些资源有不同的要求，并且会改变API对象的整个生命周期。例如，为iCloud服务创建会话所需的有效负载与asrelay服务所需的有效负载不同。

资源

这些是服务中特定的数据源。 iCloud帐户是iCloud服务的主要来源，而Reincubate Relay应用程序实例是Reincubate Relay服务的主要来源。

用户

用户代表正在请求数据的最终用户。在许多情况下，这将是您的应用程序的用户。

会议

会话代表对特定源的访问，需要一个会话才能通过API从源中检索任何信息或数据。

创建会话相当于“登录”到iCloud帐户或与“重新孵化中继”应用程序实例“配对”。

API将异步执行会话初始化过程。这意味着创建会话的调用将立即返回，但是在初始化完成之前，该会话将无法使用。

轮询

轮询是用户可以通过API请求数据的方式。需要针对目标源的活动会话才能创建轮询。

所有民意调查都通过一项或多项任务异步处理，结果将发布到组织中配置的云存储分区。

任务

这些是API执行的基础工作。创建会话时，它还会创建一个任务，以便针对外部服务执行任何初始化。创建民意调查时，它将创建至少一项任务以执行任何必要的工作。

结果

结果是对发布到客户端存储桶的数据或文件的引用。