Panoramica

aggiornato

Questa è la documentazione per la terza versione dell'API ricloud di Reincubate . L'API fornisce agli utenti un meccanismo per accedere facilmente ai dati delle app da una varietà di fonti di dati, tra cui iCloud di Apple e il backup di iTunes locale via a mano .

Per informazioni sul prodotto, consultare la pagina del prodotto ricloud .

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 specifiche fonti di dati all'interno di un servizio. Un account iCloud è la fonte principale del servizio iCloud, mentre un'istanza client secondaria è la fonte principale del servizio asrelay .

In molti casi, un servizio avrà una gerarchia di fonti che possono essere targetizzate individualmente. Ad esempio, il servizio iCloud ha origini account e origini dispositivo.

Utente

Un utente deve sempre rappresentare l'utente finale che richiede dati. In molti casi, questo sarà un utente della tua applicazione.

Sessione

Una sessione rappresenta l'accesso a un'origine specifica ed è necessaria per recuperare informazioni o dati dall'origine tramite l'API.

La creazione di una sessione equivale a un 'accesso' a un account iCloud o 'abbinamento' con un'istanza client as-a - line .

L'API eseguirà il processo di inizializzazione della sessione in modo asincrono tramite un'attività. Ciò significa che la chiamata per creare una sessione verrà restituita immediatamente, ma la sessione non sarà pronta per essere utilizzata fino al completamento dell'inizializzazione.

Sondaggio

I sondaggi indicano come gli utenti possono richiedere i dati tramite l'API. È necessaria una sessione attiva contro la fonte mirata per l'impostazione di un sondaggio.

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 l'inizializzazione contro i servizi esterni. Quando viene creato un sondaggio, creerà almeno un'attività per eseguire il lavoro di recupero dei dati.

Concetti chiave

risorse

L'API è organizzata attorno a un insieme di risorse descritte nel riferimento alla risorsa API. Attraverso queste risorse, un client dell'API è in grado di: personalizzare la configurazione dell'API, inizializzare l'accesso all'origine dati e recuperare i dati da queste fonti.

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 un meccanismo webhook, in base al quale 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 prendere una decisione su quando e come usarlo.

Come possiamo aiutare?

Il nostro team di supporto è qui per aiutarti!

I nostri orari di ufficio sono dal lunedì al venerdì, dalle 9:00 alle 17:00 GMT. L'ora è attualmente 2:33 AM GMT.

Miriamo a rispondere a tutti i messaggi entro un giorno lavorativo.

Vai alla sezione di supporto › Contatta il team aziendale ›
Il nostro fantastico team di supporto

Possiamo migliorare questo articolo?

Ci piace ascoltare gli utenti: perché non mandarci un'email, lasciare un commento o twittare @reincubate?

© 2008 - 2019 Reincubate Ltd. Tutti i diritti riservati. Registrato in Inghilterra e Galles #5189175, VAT GB151788978. Reincubate® è un marchio registrato. Termini e Condizioni. Raccomandiamo 2FA. Costruito con a Londra.