Vue d'ensemble
Il s'agit de la documentation de l'API ricloud de Reincubate. L'API permet aux utilisateurs d'accéder à leurs propres données dans iCloud d'Apple et les sauvegardes iTunes locales via l'application Reincubate Relay.
Pour plus d'informations sur le produit, consultez la page produit de l'API ricloud .
Concepts clés
Ressources
L'API est organisée en un ensemble de ressources. Un client peut créer, récupérer, mettre à jour et détruire (CRUD) ces éléments pour configurer, déclencher et surveiller les opérations sur l'API. Voir la référence des ressources API pour plus de détails.
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 la fin d'une opération asynchrone est gérée via des webhooks, grâce auxquels les événements sont envoyés au serveur d'un client via des requêtes HTTP standard. Ces événements contiennent des informations sur où trouver les données demandées dans le compartiment d'un client, ce qui permet au client de décider quand et comment les utiliser.
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 d'application Reincubate Relay est la source principale du service Reincubate Relay.
Utilisateur
Un utilisateur représente 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 une est nécessaire pour récupérer toutes les informations ou données de la source via l'API.
La création d'une session équivaut à une «connexion» à un compte iCloud ou à un «couplage» avec une instance d'application Reincubate Relay.
L'API exécutera le processus d'initialisation de session de manière asynchrone. Cela signifie que l'appel pour créer une session reviendra immédiatement, mais la session ne sera pas prête à être utilisée tant que l'initialisation ne sera pas terminée.
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 créer 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. Lorsqu'une session est créée, elle crée également une tâche afin d'effectuer toute initialisation par rapport aux services externes. Lorsqu'un sondage est créé, il créera au moins une tâche pour effectuer tout travail nécessaire.
Résultat
Un résultat est une référence à des données ou à un fichier publié dans le compartiment de stockage d'un client.
