Überblick
Dies ist die Dokumentation für die Ricloud-API von Reincubate. Über die API können Benutzer über die Reincubate Relay-App auf ihre eigenen Daten in Apples iCloud- und lokalen iTunes-Backups zugreifen.
Produktinformationen finden Sie auf der Ricloud API-Produktseite .
Schlüssel Konzepte
Ressourcen
Die API ist in einer Reihe von Ressourcen organisiert. Ein Client kann diese erstellen, abrufen, aktualisieren und zerstören (CRUD), um Vorgänge auf der API zu konfigurieren, auszulösen und zu überwachen. Weitere Informationen finden Sie in der API-Ressourcenreferenz .
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 Webhooks, wobei Ereignisse über Standard-HTTP-Anforderungen an den Server eines Clients gesendet werden. Diese Ereignisse enthalten Informationen darüber, wo die angeforderten Daten im Bucket eines Kunden zu finden sind, sodass der Kunde entscheiden kann, wann und wie sie verwendet werden sollen.
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 Reincubate Relay-App-Instanz die primäre Quelle des Reincubate Relay-Dienstes ist.
Nutzer
Ein Benutzer repräsentiert den Endbenutzer, der Daten anfordert. In vielen Fällen ist dies ein Benutzer Ihrer Anwendung.
Session
Eine Sitzung stellt den Zugriff auf eine bestimmte Quelle dar und ist erforderlich, um Informationen oder Daten über die API aus der Quelle abzurufen.
Das Erstellen einer Sitzung entspricht einem "Anmelden" in einem iCloud-Konto oder einem "Pairing" mit einer Reincubate Relay-App-Instanz.
Die API führt den Sitzungsinitialisierungsprozess asynchron 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 für die Zielquelle ist erforderlich, damit eine Umfrage erstellt 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 zugrunde liegenden Arbeitsblöcke, 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 erstellt, um die erforderlichen Arbeiten auszuführen.
Ergebnis
Ein Ergebnis ist ein Verweis auf Daten oder eine Datei, die im Speicherbereich eines Clients veröffentlicht wurde.
