Übersicht (v2)

Aktualisierte

Einführung

Es gibt vier Dienste , die umfassen und werden verwendet , mit der ricloud API zur Interaktion: asmaster, ASAPI, aschannel und asstore. Kunden interagieren im Allgemeinen nur mit zwei dieser Dienste und nicht mit allen vier.

Die API kann in einem von zwei Arten gesteuert werden: mit asmaster oder ASAPI. Die Ergebnisse werden von aschannel (einem Firehose-Stream zum Abrufen von Daten in Echtzeit) oder asstore (einem Bucket zum Sammeln von Daten) empfangen .

Komponente Ergebnislieferung Am besten geeignet für Token-Management
asmaster aschannel Regelmäßiges Abrufen von Daten Reinkubieren
asapi aschannel oder asstore Seltener Zugriff auf geringes Volumen Auf den Kunden verschoben

Datenzugriff in Echtzeit

Bei asmaster registrieren Kunden Interessenkonten oder -geräte und empfangen neue Daten in einem Stream in Echtzeit, sobald sie verfügbar sind. asmaster ist praktisch ein intelligenter Controller für asapi , der das Verständnis der Mechanismen des Speicherns und Abrufens von Daten für einen Kunden weiter reduziert und Daten schneller und sicherer bereitstellt, als dies ein Kunde mit seiner eigenen Implementierung gegen asapi kann .

Abhängig vom zugrunde liegenden Datentyp und der zugrunde liegenden Quelle abonniert asmaster entweder intern einen Upstream-Feed mit Daten für Echtzeitaktualisierungen oder verwendet einen intelligenten Predictive Scheduler, um die Abfragen zu verwalten.

Near-Time & Batch-Datenzugriff

Mit asapi fordern Clients Daten von Konten oder Geräten an, wann immer sie möchten, und empfangen sie dann, wenn sie in einem Stream bereit sind, oder indem sie einen Bucket abrufen .

Konzepte & Services

Die ricloud- API basiert auf vier Schlüsselkonzepten: Aktionen , Aufgaben , Dienste und Konten .

Aktionen sind die grundlegende Arbeitseinheit, die von der API ausgeführt wird. Jede Aktion ist einem Dienst zugeordnet . Beispielsweise könnte man die Aktion fetch_data ausführen, die Teil des icloud Dienstes ist . Jede Aktion wird gegen ein Konto ausgeführt . Konten stellen Endbenutzerkonten dar, von denen die Servicedaten abgerufen werden. Ein Konto ist für einen Kunden zugänglich, wenn es von diesem Kunden registriert wurde. Jede Instanz einer Aktion wird als Task beschrieben und mit einer task_id .

App-Stream-Master ( asmaster )

asmaster ist ein Mechanismus zur Abonnementsteuerung für die API. Es ermöglicht Benutzern Folgendes:

  • Entdecken Sie Dienste , Aktionen und Endpunkte, zu deren Verwendung sie berechtigt sind
  • Registrieren, abmelden und mehr über Konten erfahren
  • Abonnieren und Abbestellen von automatischen Datenfeeds von Konten

Mit diesem Ansatz generiert asmaster automatisch Aufgaben für asapi und die daraus resultierenden Daten aus aschannel .

Eine ausführliche Dokumentation für asmaster finden Sie unter Abonnieren von Daten bei asmaster .

App-Stream-API ( asapi )

asapi ist ein asynchroner Kontrollmechanismus für die API. Es ermöglicht Benutzern Folgendes:

  • Entdecken Sie Dienste , Aktionen und Endpunkte, zu deren Verwendung sie berechtigt sind
  • Registrieren, abmelden und mehr über Konten erfahren
  • Übermitteln Sie asynchrone Aufgaben
  • Fragen Sie den Status von Aufgaben ab

Nach Abschluss der Aufgaben können die Daten je nach Anwendungsfall des Kunden entweder über einen Channel oder einen Store abgerufen werden.

Eine ausführliche Dokumentation für asapi finden Sie unter Anfordern von Daten bei asapi .

App Stream Channel ( Aschannel )

aschannel ist ein Streaming-Endpunkt, mit dem Clients die Ergebnisse jeder übermittelten Aufgabe in Echtzeit abrufen können, wenn sie generiert werden.

Die Ergebnisse werden abgerufen, indem eine Verbindung zum A- Kanal- Endpunkt hergestellt wird.

  • Die Ergebnisse werden im JSON-Format gestreamt
  • Sobald sie verfügbar sind, können sie vom Dienst abgerufen werden
  • Der Kanal ist zustandslos. Wenn ein Client die Übermittlung eines Ergebnisses verpasst, kann es ohne erneute Übermittlung der Aufgabe nicht wiederholt werden

Eine ausführliche Dokumentation zu aschannel finden Sie unter Streaming von Daten mit aschannel .

App Stream Speicher ( asstore )

asstore ist ein zeitlich begrenzter Ergebnisspeicher, mit dem Clients die Ergebnisse übermittelter Aufgaben abrufen können, sobald sie verfügbar sind.

  • Die Ergebnisse werden für einen begrenzten Zeitraum gespeichert, bevor sie abgelaufen und gelöscht werden
  • Ein Ergebnis kann nur einmal heruntergeladen werden. es wird gelöscht, sobald es verbraucht ist

Eine ausführliche Dokumentation für asstore finden Sie beim Herunterladen von Daten mit asstore .

Verwendete Standards

In ricloud und seiner Dokumentation werden die folgenden Standards verwendet:

  • Die API verwendet konsistent Datumsangaben im ISO-8601- Format in der UTC- Zeitzone. Der 24. Dezember würde beispielsweise als 2014-12-24 17:30:00.000000 .
  • Strukturierte Daten, die von den Komponenten von ricloud zurückgegeben werden , verwenden immer JSON . Dies wird ausnahmslos durch den application/json in den Antworten angezeigt.
  • Befehlsbeispiele in dieser Dokumentation werden im bash Format mit dem Befehl curl .

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 9:33 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

© 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.