Vue d'ensemble (v2)

Mis à jour

introduction

Il y a quatre services qui comprennent et sont utilisés pour interagir avec l'API ricloud: asmaster, ASAPI, aschannel et asstore. Les clients n'interagissent généralement qu'avec deux de ces services plutôt qu'avec les quatre.

L'API peut être contrôlée de deux manières: avec asmaster ou asapi . Les résultats sont reçus de aschannel (un flux firehose pour la récupération de données en temps réel) ou asstore (un compartiment pour la récupération de données par lots).

Composant Livraison des résultats Le mieux adapté pour Gestion des jetons
comme maître comme canal Récupération régulière des données Réincuber
asapi aschannel ou asstore Accès occasionnel à faible volume Différé au client

Accès aux données en temps réel

Avec asmaster , les clients enregistrent des comptes d'intérêts ou des appareils, puis reçoivent de nouvelles données sur un flux en temps réel, dès qu'elles deviennent disponibles. asmaster est en réalité un contrôleur intelligent pour asapi , ce qui réduit encore le besoin du client de comprendre les mécanismes de stockage et de récupération des données, et qui peut fournir des données plus rapidement et en toute sécurité, qu'un client peut alors utiliser avec sa propre implémentation contre asapi .

En fonction du type de données et de la source sous-jacents, asmaster s'abonne en interne à un flux de données en amont pour les mises à jour en temps réel ou utilise un planificateur prédictif intelligent pour gérer l'interrogation.

Accès aux données quasi instantané et par lots

Avec asapi , les clients demandent les données des comptes ou des appareils à leur guise, puis les reçoivent quand ils sont prêts sur un flux ou en interrogeant un compartiment .

Concepts et services

L'API ricloud est modélisée autour de quatre concepts clés: actions , tâches , services et comptes .

Les actions sont l'unité de base du travail effectué par l'API; chaque action est associée à un service . Par exemple, vous pouvez effectuer l' action fetch_data , qui fait partie du service icloud . Chaque action est effectuée sur un compte . Les comptes représentent les comptes d'utilisateurs finaux pour toutes les données de service extraites. Un compte est accessible à un client s'il a été enregistré par ce client. Chaque instance d'action est décrite comme une tâche et se voit attribuer un task_id .

App stream master ( asmaster )

asmaster est un mécanisme de contrôle d'abonnement pour l'API. Il permet aux utilisateurs de:

  • Découvrez les services , actions et points de terminaison qu'ils sont autorisés à utiliser
  • Inscrivez-vous, désenregistrez-vous et découvrez les comptes
  • Abonnez-vous et désabonnez-vous aux flux automatiques de données des comptes

Avec cette approche, asmaster génère automatiquement des tâches pour asapi et les données obtenues à partir de aschannel .

Une documentation détaillée pour asmaster est disponible sur Abonnement pour les données avec asmaster .

API de flux d'application ( asapi )

asapi est un mécanisme de contrôle asynchrone pour l'API. Il permet aux utilisateurs de:

  • Découvrez les services , actions et points de terminaison qu'ils sont autorisés à utiliser
  • Inscrivez-vous, désenregistrez-vous et découvrez les comptes
  • Soumettre des tâches asynchrones
  • Interroger le statut des tâches

Une fois terminées, les données des tâches peuvent être obtenues de aschannel ou asstore , en fonction du cas d'utilisation du client.

Une documentation détaillée sur asapi est disponible sur demande de données avec asapi .

Canal de flux d'application ( aschannel )

aschannel est un point de terminaison de diffusion permettant aux clients de récupérer les résultats de chaque tâche soumise, en temps réel, au fur et à mesure de leur génération.

Les résultats sont récupérés en ouvrant une connexion au point final aschannel .

  • Les résultats sont diffusés au format JSON
  • Dès qu'ils sont disponibles, ils peuvent être récupérés du service.
  • Le canal est apatride; si un client manque la transmission d'un résultat, celui-ci ne pourra pas être rejoué sans la resoumission de la tâche

Une documentation détaillée sur aschannel est disponible en streaming de données avec aschannel .

Stockage de flux d'applications ( asstore )

asstore est un magasin de résultats limité dans le temps, qui permet aux clients de récupérer les résultats des tâches soumises dès qu'ils sont disponibles.

  • Les résultats sont stockés pendant une période limitée avant d'être expirés et supprimés
  • Un résultat ne peut être téléchargé qu'une fois; il est supprimé une fois consommé

Une documentation détaillée pour asstore est disponible au téléchargement des données avec asstore .

Normes utilisées

Tout au long de ricloud et de sa documentation, les normes suivantes sont utilisées:

  • L'API utilise systématiquement des dates au format ISO-8601 , dans le fuseau horaire UTC . Par exemple, le 24 décembre serait exprimé comme 2014-12-24 17:30:00.000000 .
  • Les données structurées renvoyées par les composants de ricloud utilisent toujours JSON . Ceci est invariablement indiqué par le type de contenu application/json dans les réponses.
  • Les exemples de commandes dans cette documentation sont donnés au format bash , à l’aide de la commande curl .

Comment pouvons nous aider?

Notre équipe de support est là pour vous aider!

Nos bureaux sont ouverts du lundi au vendredi, de 9 h à 17 h GMT. L’heure est actuellement 1:20 Matin GMT.

Notre objectif est de répondre à tous les messages en un jour ouvrable.

Aller à la section support › Contacter l'équipe de l'entreprise ›
Notre superbe équipe de support

© 2008 - 2019 Reincubate Ltd. Tous droits réservés. Enregistré en Angleterre et au Pays de Galles #5189175, VAT GB151788978. Reincubate® est une marque déposée. Confidentialité et modalités. Nous recommandons l'authentification multi-facteurs. Construit avec à Londres.