Protokolle

Asynchrone Verarbeitung

Die API verwendet für alle Abfragen die asynchrone Verarbeitung. Dies schließt Interaktionen mit externen Diensten wie der iCloud ein, da dies je nach dem erforderlichen Verarbeitungsaufwand Sekunden oder Minuten dauern kann.

Eine Reihe von Standardressourceninteraktionen kann asynchrone "Nebenwirkungen" auslösen, die in der API-Referenzdokumentation beschrieben sind. Diese dienen in der Regel zur Durchführung von Gültigkeitsprüfungen oder anderen Dienstprogrammen.

Die asynchrone Grundlage der API vereinfacht auch die Schnittstelle für periodische Abfragen, die über die API ausgelöst werden. Dies bedeutet, dass Ereignis- und Ergebnisabruf gleich sind, unabhängig davon, ob Sie direkt oder über geplante Abfragen mit der API interagieren.

Antwort abwarten

Die API unterstützt das Warten auf den Abschluss asynchroner Aufgaben über langlebige Anforderungen, um die Notwendigkeit von Abfragen zu minimieren und die Gesamtantwortzeit für Endbenutzer zu verkürzen. Um diese Funktionalität zu aktivieren, fügen Ricloud-Await Ihren Anforderungen den Ricloud-Await HTTP-Header mit dem gewünschten Zeitlimitwert hinzu. Der aktuelle maximale Timeout-Wert beträgt 10 Sekunden.

Ricloud-Await: 3

Diese Funktionalität wird auf den folgenden Endpunkten unterstützt:

• Session POST /sessions erstellen
• Testen Sie die Speicherkonfiguration POST /configs/storage/{storage_config ID}/test
• Testen Sie die Webhook-Konfiguration POST /configs/webhook/{webhook_config ID}/test

Verschlüsselte Veröffentlichung

Alle von der API veröffentlichten Ergebnisse können mit einem organisationsweiten öffentlichen RSA-Schlüssel verschlüsselt werden.

Endbenutzerversuche

Für den Client steht ein Testmodul für Endbenutzer zur Verfügung. Dies kann verwendet werden, um potenziellen Endbenutzern einen "Teaser" von Daten zurückzugeben. Das Modul bietet einen Feed der letzten fünf Nachrichten sowie einen letzten Speicherort und eine Zusammenfassung der anderen verfügbaren Nachrichten.

Die Verwendung dieses Mechanismus kann kostengünstiger sein als die Verwendung eines vollständigen Schlüssels für Endbenutzerversuche.

Analyse und Berichterstellung

Der iCloud-Dienst von ricloud bietet eine Reihe zusätzlicher Funktionen für Analyse und Berichterstellung.

Für Unternehmen stehen zwei Module zur Verfügung: Grundlegende App-Nutzung, die zeigt, welche Apps an einem bestimmten Tag auf einem iOS-Gerät verwendet wurden, und erweiterte App-Nutzung, die weitere Informationen wie Anzahl der Sitzungen, Dauer der Sitzungen usw. enthält. Weitere Informationen zu diesen Modulen erhalten Sie auf Anfrage.

Forensik und Erholung

Forensische Funktionen zum Löschen und Wiederherstellen sind für eine Reihe von Modulen verfügbar, wie unten angegeben, einschließlich der Module Nachrichten (SMS, MMS und iMessage) und iCloud Photo Library.

Reinkubieren Sie haben eine Reihe von benutzerdefinierten forensischen Tools, die auf Anfrage auf andere Module angewendet werden können, einschließlich WhatsApp und WeChat.

Attributtypen

Terminzeit

Datetime-Attribute werden gemäß der ISO8601-Spezifikation formatiert. Die API gibt alle datetime-Attribute mit der UTC-Zeitzone zurück, dh "2018-08-22T10:25:05Z" .

Eine Reihe von Endpunkten für die Ressourcenliste ermöglichen das Filtern nach Datums- / Uhrzeitattributen, z. B. date_created . Um mit nützlicheren Operatoren zu filtern, stellen Sie dem Datum / Uhrzeit-Filterwert einen der lt_ , lte_ , gt_ oder gte_ .

Timedelta

Attribute vom Typ timedelta sind immer in Sekunden angegeben, sofern nicht anders angegeben.

Seitennummerierung

Die API verwendet eine Cursorbasierte Paginierung. Bei allen Aufrufen vom Listentyp werden die folgenden zusätzlichen Parameter verwendet:

• limit , um die maximale Anzahl der zurückzugebenden Artikel anzugeben. Der Standardwert ist 10, der Maximalwert 1000.
• after_id , um die ID anzugeben, ab der die Auflistung beginnen soll.
• before_id , um die Ressourcen-ID anzugeben, von der aus die Auflistung gestoppt werden soll.

Schreiben Sie die Antworten umfassen Ressourcen unter den zurückgegebenen data - Attribut. Ebenfalls enthalten ist das has_more das signalisiert, ob weitere Ressourcen aufgelistet werden können, die aufgrund des Limits nicht enthalten waren.

Tarifgrenzen

Anforderungen an die API können entweder durch ein Standardratenlimit oder durch ein In-Flight-Anforderungslimit begrenzt werden. Ersteres dient zum Minimieren des Missbrauchs von API-Ressourcen im Maßstab, während letzteres zum Schutz einzelner Ressourceninstanzen verwendet wird.

Beispiel für ein Ratenlimit : Die Anzahl der Anfragen einer einzelnen Organisation an die API ist auf 10.000 Anfragen pro Stunde begrenzt. Dies schützt vor böswilligen oder versehentlichen Verkehrsspitzen.

Beispiel für ein In-Flight-Limit : Für eine Instanz einer Quellressource kann keine Task erstellt werden, wenn bereits eine andere Task verarbeitet wird. Dadurch wird die Sitzungsintegrität aufrechterhalten, der Datenverkehr zu externen Diensten wird minimiert

Versionierung

Obwohl die großen Versionen der API eines weitgehend semantisches Versionsschema (dh v1, v2, v3) folgen, werden alle in der v3 - Version der API vorgenommenen Änderungen werden nach einem Kalenderversionsschema versioniert (dh 2018.11.06). Die Version kann global für Ihre Organisation festgelegt oder auf Anfrage über den Ricloud-Version Header festgelegt werden.

Löschbare Ressourcen

Die meisten Ressourcen können nicht gelöscht werden, dh, sie können nur von der Eigentümerorganisation deaktiviert oder von einem API-Administrator blockiert werden.