概观

更新

This is the documentation for Reincubate's ricloud API. The API provides users access to their own data in Apple's iCloud and local iTunes backups via the Reincubate Relay app.

For product information see the ricloud API product page.

关键概念

资源

The API is organised into a set of resources. A client can create, retrieve, update and destroy (CRUD) these to configure, trigger, and monitor operations on the API. See the API resource reference for more details.

异步处理

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

存储桶发布

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

Webhook通知

Notification of asynchronous operation completion is handled via webhooks, whereby events are sent to a client's server through standard HTTP requests. These events contain information on where to find requested data within a client's bucket, allowing the client to make a decision on when and how to use it.

关键术语

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

服务

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

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

资源

These are specific sources of data within a service. An iCloud account is the primary source of the iCloud service, whereas a Reincubate Relay app instance is the primary source of the Reincubate Relay service.

用户

A user represents the end-user that is requesting data. In many cases, this will be a user of your application.

会议

A session represents access to a specific source, and one is needed in order to retrieve any information or data from the source through the API.

Creating a session is the equivalent of a 'login' into an iCloud account or 'pairing' with a Reincubate Relay app instance.

The API will execute the session initialisation process asynchronously. This means the call to create a session will return immediately, but the session will not be ready to use until initialisation has completed.

轮询

Polls are how users can request data through the API. An active session against the targeted source is needed for a poll to be created.

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

任务

These are the underlying chunks of work performed by the API. When a session is created, it also creates a task in order to perform any initialisation against external services. When a poll is created, it will create at least one task to perform any necessary work.

Result

A result is a reference to data or a file published to a client's storage bucket.

我们能帮你什么吗?

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

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

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

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

我们可以改进这篇文章吗?

我们喜欢听取用户的意见:为什么不给我们发电子邮件,发表评论或发推文 @reincubate?

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