Visión general

Actualizado

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.

Conceptos clave

Recursos

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.

Procesamiento asíncrono

La API se basa en operaciones asíncronas para configurar sesiones contra servicios de terceros y procesamiento de datos. Esto le da la capacidad de administrar una gran cantidad de demanda de datos mientras interactúa con servicios externos de manera responsable. También ofrece una flexibilidad adicional para reaccionar ante las fluctuaciones en los tiempos de respuesta o la degradación de los servicios de terceros.

Publicación de cubos de almacenamiento

Los datos solicitados desde la API se publican directamente en un grupo de clientes en Google Cloud Storage o Amazon S3. Esto ayuda a minimizar los problemas relacionados con la escala de la entrega de datos, y también permite una recuperación más rápida de los datos, ya que es menos probable que la publicación se convierta en un cuello de botella.

Notificaciones de 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.

Términos clave

Antes de sumergirse en la sección de inicio, es útil estar familiarizado con algunos términos y conceptos que se utilizarán en todo momento.

Servicio

Un servicio describe una colección de fuentes de datos disponibles a través de la API. Esto incluye servicios de terceros, como iCloud, o productos Reincubate, como asrelay .

Los diferentes servicios tendrán diferentes requisitos para ciertos recursos en la API, así como para alterar el ciclo de vida general de los objetos de la API. Por ejemplo, la carga útil necesaria para crear una sesión para el servicio iCloud difiere de la que se necesita en el servicio asrelay .

Fuente

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.

Usuario

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

Sesión

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.

Encuesta

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.

Todas las encuestas se procesan de forma asíncrona mediante una o más tareas, y los resultados se publican en grupos de almacenamiento en la nube configurados en su organización.

Tarea

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.

¿Cómo podemos ayudar?

¡Nuestro equipo de soporte está aquí para ayudar!

Nuestro horario de atención es de lunes a viernes de 9 a.m. a 5 p.m. GMT. El tiempo es actualmente 1:53 AM GMT.

Intentamos responder todos los mensajes en un plazo de un día laboral.

Ir a la sección de soporte › Póngase en contacto con el equipo de la empresa. ›
Nuestro increíble equipo de soporte.

¿Podemos mejorar este artículo?

Nos encanta escuchar de los usuarios: ¿por qué no enviarnos un correo electrónico, dejar un comentario o tuitear? @reincubate?

© 2008 - 2020 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® es una marca registrada. Política de privacidad & condiciones. Recomendamos la autenticación de múltiples factores. Construido con en Londres.