Panoramica (v2)

aggiornato

introduzione

Ci sono quattro servizi che comprendono e sono utilizzati per interagire con le API ricloud: asmaster, ASAPI, aschannel e in store. I clienti generalmente interagiscono solo con due di questi servizi anziché con tutti e quattro.

L'API può essere controllata in due modi: con asmaster o asapi . I risultati vengono ricevuti da aschannel (un flusso Firehose per il recupero dei dati in tempo reale) o asstore (un bucket per il recupero batch dei dati).

Componente Consegna dei risultati Più adatto per Gestione dei token
asmaster aschannel Recupero regolare dei dati reincubare
ASAPI aschannel o asstore Raro accesso a basso volume Differito al cliente

Accesso ai dati in tempo reale

Con asmaster , i clienti registrano account o dispositivi di interesse, quindi ricevono nuovi dati su uno streaming in tempo reale quando diventano disponibili. asmaster è effettivamente un controller intelligente per asapi , che riduce ulteriormente la necessità del cliente di comprendere i meccanismi di archiviazione e recupero dei dati e che può fornire i dati in modo più rapido e sicuro di un client con la propria implementazione contro asapi .

A seconda del tipo di dati e dell'origine sottostanti, asmaster si iscrive internamente a un feed di dati upstream per gli aggiornamenti in tempo reale o utilizza uno scheduler predittivo intelligente per gestire il polling.

Accesso ai dati quasi tutti i giorni e in batch

Con asapi , i client richiedono dati da account o dispositivi come e quando lo desiderano, quindi ricevono dati quando sono pronti su uno stream o eseguendo il polling di un bucket .

Concetti e servizi

L'API ricloud è modellata attorno a quattro concetti chiave: azioni , attività , servizi e account .

Le azioni sono l'unità di base del lavoro eseguita dall'API; ogni azione è associata a un servizio . Ad esempio, si potrebbe eseguire l' azione fetch_data , parte del servizio icloud . Ogni azione viene eseguita su un account . Gli account rappresentano gli account degli utenti finali per i quali vengono recuperati i dati di servizio . Un account è accessibile a un cliente se è stato registrato da quel cliente. Ogni istanza di un'azione è descritta come un'attività e allocata a task_id .

App stream master ( asmaster )

asmaster è un meccanismo di controllo della sottoscrizione per l'API. Permette agli utenti di:

  • Scopri servizi , azioni e endpoint che sono autorizzati a utilizzare
  • Registrati, cancella e scopri i conti
  • Iscriviti e disiscriviti ai feed automatici dei dati dagli account

Con questo approccio, asmaster genera automaticamente compiti per asapi e i risultati ottenuti da aschannel .

La documentazione dettagliata di asmaster è disponibile alla sottoscrizione dei dati con asmaster .

API flusso di applicazioni ( asapi )

asapi è un meccanismo di controllo asincrono per l'API. Permette agli utenti di:

  • Scopri servizi , azioni e endpoint che sono autorizzati a utilizzare
  • Registrati, cancella e scopri i conti
  • Invia attività asincrone
  • Interrogare lo stato delle attività

Una volta completato, i dati delle attività possono essere ottenuti da aschannel o asstore , a seconda del caso d'uso del cliente.

La documentazione dettagliata per asapi è disponibile alla richiesta dei dati con asapi .

Canale streaming app ( ascanale )

aschannel è un endpoint di streaming, che consente ai client di recuperare i risultati di ciascuna attività inoltrata, in tempo reale, man mano che vengono generati.

I risultati vengono recuperati aprendo una connessione all'endpoint ascanale .

  • I risultati sono trasmessi in streaming in formato JSON
  • Non appena diventano disponibili possono essere recuperati dal servizio
  • Il canale è senza stato; se un cliente perde la trasmissione di un risultato, non può essere riprodotto senza ripresentazione del compito

La documentazione dettagliata per aschannel è disponibile ai dati di streaming con aschannel .

Archiviazione stream di app ( asstore )

asstore è un archivio di risultati limitato nel tempo, che consente ai clienti di recuperare i risultati delle attività inoltrate man mano che diventano disponibili.

  • I risultati vengono archiviati per un periodo limitato prima di essere scaduti e cancellati
  • Un risultato può essere scaricato solo una volta; viene cancellato una volta consumato

La documentazione dettagliata per asstore è disponibile per il download dei dati con asstore .

Standard usati

In tutto ricloud e la sua documentazione, vengono utilizzati i seguenti standard:

  • L'API utilizza costantemente date nel formato ISO-8601 , nel fuso orario UTC . Ad esempio, il 24 dicembre sarà espresso come 2014-12-24 17:30:00.000000 .
  • I dati strutturati restituiti dai componenti di ricloud utilizzano sempre JSON . Ciò è invariabilmente indicato dal tipo di contenuto application/json nelle risposte.
  • Gli esempi di comando in questa documentazione sono forniti in formato bash , usando il comando curl .

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 1:22 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

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