Vue d'ensemble

Mis à jour

Voici la documentation de la troisième version de l'API ricloud de Reincubate . L'API offre aux utilisateurs un mécanisme leur permettant d'accéder facilement aux données d'applications à partir de diverses sources de données, notamment la sauvegarde iCloud d'Apple et la sauvegarde locale iTunes via asrelay .

Pour plus d'informations sur les produits, voir la page produit de ricloud .

Mots clés

Avant de plonger dans la section de démarrage, il est utile de connaître quelques termes et concepts qui seront utilisés tout au long.

Un service

Un service décrit un ensemble de sources de données disponibles via l'API. Cela inclut les services tiers, tels que les produits iCloud ou Reincubate, tels que asrelay .

Différents services auront des exigences variables pour certaines ressources de l'API et modifieront le cycle de vie global des objets de l'API. Par exemple, la charge utile nécessaire pour créer une session pour le service iCloud diffère de celle requise sur le service asrelay .

La source

Ce sont des sources de données spécifiques au sein d'un service. Un compte iCloud est la source principale du service iCloud, tandis qu'une instance client asrelay est la source principale du service asrelay .

Dans de nombreux cas, un service aura une hiérarchie de sources pouvant être ciblées individuellement. Par exemple, le service iCloud a des sources de compte et des sources de périphérique.

Utilisateur

Un utilisateur doit toujours représenter l'utilisateur final qui demande des données. Dans de nombreux cas, ce sera un utilisateur de votre application.

Session

Une session représente l'accès à une source spécifique et est nécessaire pour extraire toute information ou donnée de la source via l'API.

La création d'une session équivaut à une "connexion" à un compte iCloud ou à un "couplage" avec une instance de client asrelay .

L'API exécutera le processus d'initialisation de la session de manière asynchrone via une tâche. Cela signifie que l'appel à créer une session retournera immédiatement, mais que la session ne sera pas prête à être utilisée avant l'initialisation.

Sondage

Les sondages permettent aux utilisateurs de demander des données via l'API. Une session active sur la source ciblée est nécessaire pour la configuration d’un sondage.

Toutes les interrogations sont traitées de manière asynchrone via une ou plusieurs tâches et les résultats sont publiés dans des compartiments de stockage en cloud configurés sur votre organisation.

Tâche

Ce sont les morceaux de travail sous-jacents effectués par l'API. Lors de la création d'une session, une tâche est également créée afin d'effectuer toute initialisation avec des services externes. Lors de la création d'un sondage, il créera au moins une tâche pour effectuer le travail de récupération des données.

Concepts clés

Ressources

L'API est organisée autour d'un ensemble de ressources décrit dans la référence de ressource d'API. Grâce à ces ressources, un client de l'API est capable de: personnaliser sa configuration d'API, initialiser l'accès à une source de données et extraire des données de ces sources

Traitement asynchrone

L'API repose sur des opérations asynchrones pour la configuration de sessions sur des services tiers et le traitement de données. Cela lui permet de gérer une grande quantité de données tout en interagissant de manière responsable avec des services externes. Il offre également une flexibilité supplémentaire pour réagir aux fluctuations des temps de réponse ou à la dégradation des services fournis par des tiers.

Publication de bacs de stockage

Les données demandées à l'API sont publiées directement dans le compartiment d'un client sur Google Cloud Storage ou Amazon S3. Cela permet de minimiser les problèmes liés à l’évolutivité de la livraison des données et permet également une extraction plus rapide des données, car la publication risque moins de devenir un goulot d’étranglement.

Notifications Webhook

La notification de l'achèvement des opérations asynchrones est gérée via un mécanisme webhook, les événements étant envoyés au serveur du client via des requêtes HTTP standard. Ces événements contiennent des informations sur l'endroit où trouver les données demandées dans le compartiment d'un client, ce qui lui permet de décider quand et comment les utiliser.

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:54 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

Pouvons-nous améliorer cet article?

Nous aimons entendre les utilisateurs: pourquoi ne pas nous envoyer un email, laisser un commentaire ou tweet @reincubate?

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