Vue d'ensemble

Mis à jour

This is the documentation for Reincubate's ricloud API. The API provides users access to their own data in Apple's iCloud and local iTunes backups via the Reincubate Relay app.

For product information see the ricloud API product page.

Concepts clés

Ressources

The API is organised into a set of resources. A client can create, retrieve, update and destroy (CRUD) these to configure, trigger, and monitor operations on the API. See the API resource reference for more details.

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

Notification of asynchronous operation completion is handled via webhooks, whereby events are sent to a client's server through standard HTTP requests. These events contain information on where to find requested data within a client's bucket, allowing the client to make a decision on when and how to use it.

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

These are specific sources of data within a service. An iCloud account is the primary source of the iCloud service, whereas a Reincubate Relay app instance is the primary source of the Reincubate Relay service.

Utilisateur

A user represents the end-user that is requesting data. In many cases, this will be a user of your application.

Session

A session represents access to a specific source, and one is needed in order to retrieve any information or data from the source through the API.

Creating a session is the equivalent of a 'login' into an iCloud account or 'pairing' with a Reincubate Relay app instance.

The API will execute the session initialisation process asynchronously. This means the call to create a session will return immediately, but the session will not be ready to use until initialisation has completed.

Sondage

Polls are how users can request data through the API. An active session against the targeted source is needed for a poll to be created.

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

These are the underlying chunks of work performed by the API. When a session is created, it also creates a task in order to perform any initialisation against external services. When a poll is created, it will create at least one task to perform any necessary work.

Result

A result is a reference to data or a file published to a client's storage bucket.

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 9:45 Après-midi 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 - 2020 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. Politique de confidentialité & termes. Nous recommandons l'authentification multi-facteurs. Construit avec à Londres.