Visión general
Esta es la documentación para la API ricloud de Reincubate. La API proporciona a los usuarios acceso a sus propios datos en iCloud de Apple y copias de seguridad locales de iTunes a través de la aplicación Reincubate Relay.
Para obtener información sobre el producto, consulte la página del producto API de ricloud .
Conceptos clave
Recursos
La API está organizada en un conjunto de recursos. Un cliente puede crear, recuperar, actualizar y destruir (CRUD) estos para configurar, activar y monitorear operaciones en la API. Consulte la referencia de recursos API para más detalles.
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 asincrónica se maneja a través de webhooks, por lo que 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 depósito de un cliente, lo que le permite al cliente tomar una decisión sobre cuándo y cómo usarlo.
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 de datos específicas dentro de un servicio. Una cuenta de iCloud es la fuente principal del servicio de iCloud, mientras que una instancia de la aplicación Reincubate Relay es la fuente principal del servicio Reincubate Relay.
Usuario
Un usuario representa al usuario final que solicita 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 se necesita una 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 la aplicación Reincubate Relay.
La API ejecutará el proceso de inicialización de la sesión de forma asincrónica. Esto significa que la llamada para crear una sesión regresará de inmediato, pero la sesión no estará lista para usar hasta que se complete la inicialización.
Encuesta
Las encuestas muestran cómo los usuarios pueden solicitar datos a través de la API. Se necesita una sesión activa contra la fuente de destino para crear 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 fragmentos de trabajo subyacentes realizados 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 cualquier trabajo necesario.
Resultado
Un resultado es una referencia a datos o un archivo publicado en el depósito de almacenamiento de un cliente.
