Visión general

Actualizado

Es la documentación de la tercera versión de la API ricloud de Reincubate . La API proporciona un mecanismo para que los usuarios accedan fácilmente a los datos de la aplicación desde una variedad de fuentes de datos, incluyendo iCloud de Apple y la copia de seguridad local de iTunes a través de asrelay .

Para obtener información sobre el producto, consulte la página del producto ricloud .

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

Estas son fuentes específicas de datos dentro de un servicio. Una cuenta de iCloud es la fuente principal del servicio de iCloud, mientras que una instancia de cliente asrelay es la fuente principal del servicio asrelay .

En muchos casos, un servicio tendrá una jerarquía de fuentes que pueden dirigirse individualmente. Por ejemplo, el servicio iCloud tiene orígenes de cuenta y orígenes de dispositivo.

Usuario

Un usuario siempre debe representar al usuario final que está solicitando datos. En muchos casos, este será un usuario de su aplicación.

Sesión

Una sesión representa el acceso a una fuente específica y es necesaria para recuperar cualquier información o datos de la fuente a través de la API.

Crear una sesión es el equivalente a un "inicio de sesión" en una cuenta de iCloud o "emparejamiento" con una instancia de un cliente de recuperación .

La API ejecutará el proceso de inicialización de la sesión de forma asíncrona a través de una tarea. Esto significa que la llamada para crear una sesión volverá de inmediato, pero la sesión no estará lista para usarse hasta que se complete la inicialización.

Encuesta

Las encuestas son cómo los usuarios pueden solicitar datos a través de la API. Se necesita una sesión activa contra el origen seleccionado para que se configure una encuesta.

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

Estos son los trozos subyacentes del trabajo realizado por la API. Cuando se crea una sesión, también crea una tarea para realizar cualquier inicialización contra servicios externos. Cuando se crea una encuesta, creará al menos una tarea para realizar el trabajo de recuperación de datos.

Conceptos clave

Recursos

La API se organiza en torno a un conjunto de recursos descritos en la referencia de recursos de la API. A través de estos recursos, un cliente de la API puede: personalizar su configuración de API, inicializar el acceso a la fuente de datos y recuperar datos de estas fuentes.

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

La notificación de la finalización de la operación asíncrona se maneja a través de un mecanismo de webhook, mediante el cual los eventos se envían al servidor de un cliente a través de solicitudes HTTP estándar. Estos eventos contienen información sobre dónde encontrar los datos solicitados dentro del grupo de un cliente, lo que permite al cliente tomar una decisión sobre cuándo y cómo usarlo.

¿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 4:35 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 - 2019 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® es una marca registrada. Términos y privacidad. Recomendamos la autenticación de múltiples factores. Construido con en Londres.