Überblick

Aktualisierte

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.

Schlüssel Konzepte

Ressourcen

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.

Asynchrone Verarbeitung

Die API stützt sich auf asynchrone Vorgänge zum Einrichten von Sitzungen für Dienste und Datenverarbeitung von Drittanbietern. Dies gibt ihm die Möglichkeit, einen großen Datenbedarf zu verwalten und gleichzeitig verantwortungsbewusst mit externen Diensten zu interagieren. Darüber hinaus bietet es zusätzliche Flexibilität, um auf Schwankungen der Antwortzeiten oder Leistungsabfälle von Drittanbietern zu reagieren.

Storage Bucket Publishing

Von der API angeforderte Daten werden direkt im Bucket eines Kunden in Google Cloud Storage oder Amazon S3 veröffentlicht. Auf diese Weise werden Probleme im Zusammenhang mit der Skalierung der Datenlieferung minimiert und der Datenabruf beschleunigt, da das Veröffentlichen mit geringerer Wahrscheinlichkeit zu einem Engpass wird.

Webhook-Benachrichtigungen

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.

Schlüsselbegriffe

Bevor Sie in den Einstiegsbereich eintauchen, ist es hilfreich, sich mit einigen Begriffen und Konzepten vertraut zu machen, die in allen Abschnitten verwendet werden.

Bedienung

Ein Dienst beschreibt eine Sammlung von Datenquellen, die über die API verfügbar sind. Dies umfasst Dienste von Drittanbietern wie iCloud oder Reincubate-Produkte wie asrelay .

Unterschiedliche Services stellen unterschiedliche Anforderungen an bestimmte Ressourcen der API und verändern den gesamten Lebenszyklus von API-Objekten. Beispielsweise unterscheidet sich die zum Erstellen einer Sitzung für den iCloud-Dienst erforderliche Nutzlast von der für den asrelay- Dienst erforderlichen .

Quelle

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.

Nutzer

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.

Umfrage

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.

Alle Umfragen werden über eine oder mehrere Aufgaben asynchron verarbeitet, und die Ergebnisse werden in den in Ihrer Organisation konfigurierten Cloud-Speicher-Buckets veröffentlicht.

Aufgabe

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.

Wie können wir helfen?

Unser Support-Team hilft Ihnen gerne weiter!

Unsere Bürozeiten sind Montag bis Freitag von 9 bis 17 Uhr GMT. Die Zeit ist aktuell 2:23 vorm. GMT.

Wir bemühen uns, auf alle Mitteilungen innerhalb eines Arbeitstages zu antworten.

Zum Support-Bereich gehen › Wenden Sie sich an das Unternehmensteam ›
Unser großartiges Supportteam

Können wir diesen Artikel verbessern?

Wir hören gerne von Nutzern: Warum schicken Sie uns nicht eine E-Mail, schreiben Sie einen Kommentar oder tweeten Sie @reincubate?

© 2008 - 2020 Reincubate Ltd. Alle Rechte vorbehalten. Registriert in England und Wales #5189175, VAT GB151788978. Reincubate® ist eine eingetragene Marke. Datenschutz-Bestimmungen & Begriffe. Wir empfehlen die Multi-Faktor-Authentifizierung. Mit Liebe in London gebaut.