protocolli

Elaborazione asincrona

L'API utilizza l'elaborazione asincrona per tutti i sondaggi. Ciò include interazioni con servizi esterni, come iCloud, in quanto possono richiedere secondi o minuti a seconda della quantità di elaborazione richiesta.

Un numero di interazioni di risorse standard può attivare "effetti collaterali" asincroni che sono delineati nella documentazione di riferimento dell'API. Questi sono in genere per eseguire controlli di validità o altre funzioni di utilità.

La base asincrona dell'API aiuta anche a semplificare l'interfaccia per il polling periodico che viene attivato dall'interno dell'API. Ciò significa che il recupero di eventi e risultati è lo stesso sia che interagisca con l'API direttamente o tramite sondaggi pianificati.

Attendi risposta

L'API supporta l'attesa del completamento di attività asincrone tramite richieste di lunga durata per ridurre al minimo la necessità di polling e ridurre il tempo di risposta totale per gli utenti finali. Per abilitare questa funzionalità, aggiungi l' Ricloud-Await HTTP alle tue richieste con il valore di timeout desiderato. Il valore di timeout massimo corrente è 10 secondi.

Ricloud-Await: 3

Questa funzionalità è supportata sui seguenti endpoint:

• Crea POST /sessions
• Test di configurazione POST /configs/storage/{storage_config ID}/test
• Test POST /configs/webhook/{webhook_config ID}/test

Pubblicazione crittografata

Tutti i risultati pubblicati dall'API possono essere crittografati utilizzando una chiave RSA pubblica a livello di organizzazione.

Prove per l'utente finale

Un modulo di prova per l'utente finale è disponibile per l'uso client. Questo può essere usato per restituire un "teaser" di dati a potenziali utenti finali. Il modulo fornisce un feed degli ultimi cinque messaggi insieme a un'ultima posizione e un conteggio riepilogativo degli altri messaggi disponibili.

L'uso di questo meccanismo può essere più conveniente rispetto all'utilizzo di una chiave completa per le prove dell'utente finale.

Analisi e reportistica

Il servizio iCloud di ricloud offre una serie di funzionalità aggiuntive relative a analisi e reportistica.

Sono disponibili due moduli per le imprese: l'utilizzo di base delle app, che mostra quali app sono state utilizzate su un dispositivo iOS in un dato giorno e l'utilizzo avanzato delle app, che fornisce ulteriori informazioni tra cui numero di sessioni, durata delle sessioni e così via. Ulteriori informazioni su questi moduli sono disponibili su richiesta.

Forense e recupero

La funzionalità di eliminazione e recupero forensi è disponibile per un numero di moduli come indicato di seguito, inclusi i moduli Messaggi (SMS, MMS e iMessage) e iCloud Photo Library.

Reincubare avere un numero di strumenti forensi personalizzati che possono essere applicati su richiesta ad altri moduli, tra cui WhatsApp e WeChat.

Tipi di attributi

Appuntamento

Gli attributi Datetime sono formattati secondo la specifica ISO8601. L'API restituisce tutti gli attributi datetime con il fuso orario UTC, ad esempio "2018-08-22T10:25:05Z" .

Numerosi endpoint di elenco delle risorse consentono di filtrare gli attributi datetime, come date_created . Per filtrare usando operatori più utili, lt_ valore del filtro datetime a uno di lt_ , lte_ , gt_ o gte_ .

timedelta

Gli attributi del tipo timedelta sono sempre in secondi se non diversamente specificato.

paginatura

L'API utilizza l'impaginazione basata su cursore. Tutte le chiamate di tipo elenco prendono i parametri aggiuntivi:

• limit per specificare il numero massimo di articoli da restituire. Il valore predefinito è 10, valore massimo 1000.
• after_id per specificare l'ID da cui iniziare l'elenco.
• before_id per specificare l'ID della risorsa da cui interrompere l'elenco.

Le risposte elenco includono risorse restituite sotto l'attributo data . Inoltre è incluso l'attributo helper has_more che segnala se è possibile elencare più risorse che non sono state incluse a causa del limite.

Limiti di velocità

Le richieste all'API possono essere limitate da un limite tariffario standard o da un limite di richieste in volo. Il primo viene utilizzato per ridurre al minimo l'abuso di risorse API su scala, mentre il secondo viene utilizzato per proteggere le istanze di singole risorse.

Esempio di limite di velocità: il numero di richieste all'API da una singola organizzazione è limitato a 10.000 richieste all'ora. Questo aiuta a proteggere da picchi dannosi o accidentali nel traffico.

Esempio di limite di volo : un'istanza di una risorsa di origine non può avere un'attività creata contro di essa se un'altra attività è già in elaborazione. Ciò mantiene l'integrità della sessione, minimizza il traffico verso i servizi esterni e

versioning

Sebbene le principali versioni dell'API seguano uno schema di gestione delle versioni in gran parte semantico (ad esempio v1 , v2 , v3 ), tutte le modifiche apportate all'interno della versione v3 dell'API sono sottoposte alla versione successiva a uno schema di controllo delle versioni del calendario (ad esempio 2018-11-06 ). La versione può essere impostata globalmente per la tua organizzazione o specificata per richiesta tramite l'intestazione Ricloud-Version .

Risorse cancellabili

La maggior parte delle risorse non è cancellabile, il che significa che possono essere disattivate solo dall'organizzazione proprietaria o bloccate da un amministratore API.