Panoramica
Questa è la documentazione per l'API ricloud di Reincubate. L'API fornisce agli utenti l'accesso ai propri dati in iCloud di Apple e backup iTunes locali tramite l'app Reincubate Relay.
Per informazioni sul prodotto, consultare la pagina del prodotto API ricloud .
Concetti chiave
risorse
L'API è organizzata in un insieme di risorse. Un client può creare, recuperare, aggiornare e distruggere (CRUD) per configurare, attivare e monitorare le operazioni sull'API. Vedere il riferimento alla risorsa API per ulteriori dettagli.
Elaborazione asincrona
L'API si basa su operazioni asincrone per l'impostazione di sessioni contro servizi di terze parti e l'elaborazione dei dati. Ciò gli consente di gestire una grande quantità di richieste di dati interagendo responsabilmente con i servizi esterni. Offre inoltre una maggiore flessibilità per reagire alle fluttuazioni nei tempi di risposta o al degrado nei servizi di terzi.
Pubblicazione del bucket di archiviazione
I dati richiesti dall'API vengono pubblicati direttamente nel bucket di un cliente su Google Cloud Storage o Amazon S3. Ciò consente di ridurre al minimo i problemi legati al ridimensionamento della trasmissione dei dati e consente inoltre un recupero dei dati più rapido in quanto è meno probabile che la pubblicazione diventi un collo di bottiglia.
Notifiche di Webhook
La notifica del completamento dell'operazione asincrona viene gestita tramite webhook, per cui gli eventi vengono inviati al server di un client tramite richieste HTTP standard. Questi eventi contengono informazioni su dove trovare i dati richiesti all'interno del bucket di un cliente, consentendo al cliente di decidere quando e come utilizzarlo.
Parole chiave
Prima di tuffarsi nella sezione introduttiva, è utile avere familiarità con una manciata di termini e concetti che verranno utilizzati in tutto.
Servizio
Un servizio descrive una raccolta di origini dati disponibili tramite l'API. Questo include servizi di terze parti, come ad esempio iCloud, o prodotti reincubare, come asrelay.
Servizi diversi avranno requisiti diversi per determinate risorse sull'API, oltre a modificare il ciclo di vita complessivo degli oggetti API. Ad esempio, il carico utile necessario per creare una sessione per il servizio iCloud è diversa da quella necessaria sul servizio asrelay.
fonte
Queste sono fonti specifiche di dati all'interno di un servizio. Un account iCloud è la fonte principale del servizio iCloud, mentre un'istanza dell'app Reincubate Relay è la fonte primaria del servizio Reincubate Relay.
Utente
Un utente rappresenta l'utente finale che richiede dati. In molti casi, questo sarà un utente dell'applicazione.
Sessione
Una sessione rappresenta l'accesso a una fonte specifica ed è necessaria una per recuperare qualsiasi informazione o dato dalla fonte attraverso l'API.
La creazione di una sessione equivale a un 'accesso' a un account iCloud o 'associazione' con un'istanza dell'app Reincubate Relay.
L'API eseguirà il processo di inizializzazione della sessione in modo asincrono. Ciò significa che la chiamata per creare una sessione tornerà immediatamente, ma la sessione non sarà pronta per l'uso fino al completamento dell'inizializzazione.
Sondaggio
I sondaggi indicano come gli utenti possono richiedere dati tramite l'API. Per creare un sondaggio è necessaria una sessione attiva sull'origine target.
Tutti i sondaggi vengono elaborati in modo asincrono tramite una o più attività e i risultati vengono pubblicati nei bucket di archiviazione cloud configurati sulla propria organizzazione.
Compito
Questi sono i blocchi di lavoro sottostanti eseguiti dall'API. Quando viene creata una sessione, crea anche un'attività per eseguire qualsiasi inizializzazione contro servizi esterni. Quando viene creato un sondaggio, verrà creata almeno un'attività per eseguire tutto il lavoro necessario.
Risultato
Un risultato è un riferimento a dati o file pubblicati nel bucket di archiviazione di un client.
