Überblick

Aktualisierte

Das ist die Dokumentation für die dritte Version von inkubieren der ricloud API. Die API bietet Benutzern einen Mechanismus für den einfachen Zugriff auf App-Daten aus einer Vielzahl von Datenquellen, einschließlich Apples iCloud und lokaler iTunes-Sicherung über asrelay .

Produktinformationen finden Sie auf der ricloud Produktseite .

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

Dies sind bestimmte Datenquellen innerhalb eines Dienstes. Ein iCloud-Konto ist die primäre Quelle des iCloud-Dienstes, während eine Asrelay- Client-Instanz die primäre Quelle des Asrelay- Dienstes ist.

In vielen Fällen verfügt ein Dienst über eine Hierarchie von Quellen, auf die individuell abgezielt werden kann. Der iCloud-Dienst verfügt beispielsweise über Konto- und Gerätequellen.

Nutzer

Ein Benutzer sollte immer den Endbenutzer darstellen, der Daten anfordert. In vielen Fällen wird dies ein Benutzer Ihrer Anwendung sein.

Session

Eine Sitzung stellt den Zugriff auf eine bestimmte Quelle dar und wird benötigt, um Informationen oder Daten aus der Quelle über die API abzurufen.

Das Erstellen einer Sitzung entspricht dem Anmelden bei einem iCloud-Konto oder dem Koppeln mit einer Asrelay- Client-Instanz.

Die API führt den Sitzungsinitialisierungsprozess asynchron über eine Task aus. Dies bedeutet, dass der Aufruf zum Erstellen einer Sitzung sofort zurückgegeben wird, die Sitzung jedoch erst nach Abschluss der Initialisierung einsatzbereit ist.

Umfrage

In Umfragen können Benutzer Daten über die API anfordern. Eine aktive Sitzung mit der Zielquelle ist erforderlich, damit eine Umfrage eingerichtet werden kann.

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

Dies sind die grundlegenden Arbeitsschritte, die von der API ausgeführt werden. Wenn eine Sitzung erstellt wird, wird auch eine Aufgabe erstellt, um eine Initialisierung für externe Dienste durchzuführen. Wenn eine Umfrage erstellt wird, wird mindestens eine Aufgabe zum Ausführen der Datenabrufarbeit erstellt.

Schlüssel Konzepte

Ressourcen

Die API besteht aus einer Reihe von Ressourcen, die in der API-Ressourcenreferenz beschrieben sind. Über diese Ressourcen kann ein Client der API: seine API-Konfiguration anpassen, den Zugriff auf die Datenquelle initialisieren und Daten aus diesen Quellen abrufen.

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

Die Benachrichtigung über den Abschluss eines asynchronen Vorgangs erfolgt über einen Webhook-Mechanismus, bei dem Ereignisse über Standard-HTTP-Anforderungen an den Server eines Clients gesendet werden. Diese Ereignisse enthalten Informationen darüber, wo angeforderte Daten im Bucket eines Kunden zu finden sind, sodass der Kunde entscheiden kann, wann und wie er sie verwenden soll.

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 10:08 nachm. 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 - 2019 Reincubate Ltd. Alle Rechte vorbehalten. Registriert in England und Wales #5189175, VAT GB151788978. Reincubate® ist eine eingetragene Marke. Datenschutz. Wir empfehlen die Multi-Faktor-Authentifizierung. Mit Liebe in London gebaut.