Visión general (v2)

Actualizado

Introducción

Hay cuatro servicios que componen y se utilizan para interactuar con el API ricloud: asmaster, ASAPI, aschannel y asstore. Los clientes generalmente solo interactúan con dos de estos servicios en lugar de con los cuatro.

La API se puede controlar de una de dos maneras: con asmaster o asapi . Los resultados se reciben de aschannel (un flujo de Firehose para la recuperación de datos en tiempo real) o asstore (un grupo para la recuperación de datos por lotes).

Componente Entrega de resultados Mejor adecuado para Manejo de fichas
asmaster canal de cocina Recuperación regular de datos Reincubar
asapi canal o asstore Acceso infrecuente de bajo volumen Diferido al cliente

Acceso a datos en tiempo real.

Con asmaster, los clientes se registren las cuentas de interés o dispositivos, a continuación, reciben nuevos datos sobre un flujo en tiempo real cuando se encuentre disponible. asmaster es efectivamente un controlador inteligente para asapi , que reduce aún más la necesidad de un cliente de comprender los mecanismos de almacenamiento y recuperación de datos, y que puede proporcionar datos de forma más rápida y segura, por lo que un cliente puede realizar su propia implementación contra asapi .

Dependiendo del tipo de datos subyacente y la fuente, asmaster se suscribe internamente a una fuente de datos ascendente para actualizaciones en tiempo real, o utiliza un planificador predictivo inteligente para administrar el sondeo.

Acceso a tiempo parcial y de datos por lotes

Con ASAPI, los clientes solicitan datos de cuentas o dispositivos como y cuando lo desean, a continuación, recibir datos cuando está listo en una corriente o mediante el sondeo de balde .

Conceptos y servicios

La API de ricloud se basa en cuatro conceptos clave: acciones , tareas , servicios y cuentas .

Las acciones son la unidad básica de trabajo realizada por la API; Cada acción está asociada a un servicio . Por ejemplo, uno podría realizar la acción fetch_data , parte del servicio icloud . Cada acción se realiza contra una cuenta . Las cuentas representan cuentas de usuario final para los datos de servicio que se recuperan. Una cuenta es accesible para un cliente si ha sido registrada por ese cliente. Cada instancia de una acción se describe como una tarea y se le asigna un task_id .

App stream master ( asmaster )

asmaster es un mecanismo de control de suscripción para la API. Permite a los usuarios:

  • Descubra servicios , acciones y puntos finales que están autorizados a usar.
  • Regístrese, cancele el registro y conozca las cuentas.
  • Suscríbase y anule la suscripción a las fuentes automáticas de datos de cuentas.

Con este enfoque, asmaster genera automáticamente tareas para asapi y los datos resultantes obtenidos de aschannel .

La documentación detallada para asmaster está disponible en la suscripción de datos con asmaster .

API de flujo de aplicaciones ( asapi )

asapi es un mecanismo de control asíncrono para la API. Permite a los usuarios:

  • Descubra servicios , acciones y puntos finales que están autorizados a usar.
  • Regístrese, cancele el registro y conozca las cuentas.
  • Enviar tareas asíncronas.
  • Consultar el estado de las tareas.

Una vez completados, los datos de las tareas se pueden obtener de un canal o de un almacén , según el caso de uso del cliente.

La documentación detallada para asapi está disponible al solicitar datos con asapi .

Canal de flujo de aplicaciones ( aschannel )

aschannel es un punto final de transmisión, que permite a los clientes recuperar los resultados de cada tarea enviada, en tiempo real, a medida que se generan.

Los resultados se recuperan al abrir una conexión al punto final de un canal .

  • Los resultados se transmiten en formato JSON
  • Tan pronto como estén disponibles, se pueden recuperar del servicio.
  • El canal es apátrida; Si un cliente pierde la transmisión de un resultado, no puede reproducirse sin volver a enviar la tarea.

La documentación detallada para aschannel está disponible en transmisión de datos con aschannel .

Almacenamiento de flujo de aplicaciones ( asstore )

asstore es un almacén de resultados limitado en el tiempo, que permite a los clientes recuperar los resultados de las tareas enviadas a medida que están disponibles.

  • Los resultados se almacenan durante un período limitado antes de que caduquen y se eliminen
  • Un resultado solo se puede descargar una vez; se elimina una vez consumido

La documentación detallada para asstore está disponible en la descarga de datos con asstore .

Normas utilizadas

A lo largo de ricloud y su documentación, se utilizan los siguientes estándares:

  • La API utiliza constantemente fechas en el formato ISO-8601 , en la zona horaria UTC . Por ejemplo, el 24 de diciembre se expresaría como 2014-12-24 17:30:00.000000 .
  • Los datos estructurados devueltos por los componentes de ricloud siempre usan JSON . Esto está indicado invariablemente por el tipo de contenido de application/json en las respuestas.
  • Los ejemplos de comandos en esta documentación se dan en formato bash , usando el comando curl .

¿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 10:35 PM 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.

© 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.