Overzicht (v2)

bijgewerkt

Invoering

Er zijn vier services die bestaan uit en worden gebruikt om te communiceren met de ricloud- API: asmaster , asapi , aschannel en asstore . Klanten hebben doorgaans alleen interactie met twee van deze services in plaats van alle vier.

De API kan op twee manieren worden beheerd: met asmaster of asapi . Resultaten worden ontvangen van aschannel (een brandslangstroom voor het in real time ophalen van gegevens) of asstore (een emmer voor het batch ophalen van gegevens).

bestanddeel Resultaten levering Meest geschikt voor Token management
asmaster aschannel Regelmatig ophalen van gegevens Reincubate
ASAPI aschannel of asstore Onregelmatige toegang met een laag volume Uitgesteld naar klant

Realtime gegevenstoegang

Met asmaster registreren klanten renteaccounts of apparaten en ontvangen vervolgens nieuwe gegevens over een stream in realtime wanneer deze beschikbaar komt. asmaster is in feite een slimme controller voor asapi , wat de behoefte van een klant om de mechanica van gegevensopslag en -herstel te begrijpen nog verder vermindert en die sneller en veiliger gegevens kan leveren dan een klant kan met zijn eigen implementatie tegen asapi .

Afhankelijk van het onderliggende datatype en de bron, schrijft asmaster zich intern in voor een upstream-feed van gegevens voor real-time updates of gebruikt een slim voorspellende planner om polling te beheren.

Toegang tot bijna-tijd en batchtata

Met asapi vragen klanten gegevens aan vanaf accounts of apparaten waar en wanneer ze dat willen, en ontvangen ze vervolgens gegevens wanneer deze klaar zijn op een stream of door een bucket te pollen.

Concepten & diensten

De ricloud- API is gebaseerd op vier kernbegrippen: acties , taken , services en accounts .

Acties zijn de basiseenheid van het werk uitgevoerd door de API; elke actie is gekoppeld aan een service . U kunt bijvoorbeeld de actie fetch_data uitvoeren, onderdeel van de icloud service . Elke actie wordt uitgevoerd tegen een account . Accounts vertegenwoordigen eindgebruikersaccounts voor het ophalen van servicegegevens . Een account is toegankelijk voor een klant als het door die klant is geregistreerd. Elke instantie van een actie wordt beschreven als een taak en een task_id toegewezen.

App- streammaster ( asmaster )

asmaster is een abonnementscontrolemechanisme voor de API. Het stelt gebruikers in staat om:

  • Ontdek services , acties en eindpunten die ze mogen gebruiken
  • Registreer, deregistreren en leer over accounts
  • Abonneren en afmelden voor automatische feeds van gegevens van accounts

Met deze aanpak genereert asmaster automatisch taken voor asapi , en resulterende gegevens verkregen via aschannel .

Gedetailleerde documentatie voor asmaster is beschikbaar bij het abonneren op gegevens met asmaster .

App stream API ( asapi )

asapi is een asynchroon besturingsmechanisme voor de API. Het stelt gebruikers in staat om:

  • Ontdek services , acties en eindpunten die ze mogen gebruiken
  • Registreer, deregistreren en leer over accounts
  • Asynchrone taken verzenden
  • Vraag de status van taken op

Na voltooiing kunnen gegevens van taken worden verkregen via aschannel of asstore , afhankelijk van de gebruikscasus van de klant.

Gedetailleerde documentatie voor asapi is beschikbaar bij het aanvragen van gegevens met asapi .

App- streamkanaal ( askanaal )

aschannel is een streaming-eindpunt, waarmee klanten de resultaten van elke ingediende taak in realtime kunnen ophalen, zoals ze worden gegenereerd.

Resultaten worden opgehaald door een verbinding met het aschannel- eindpunt te openen.

  • Resultaten worden gestreamd in JSON-formaat
  • Zodra ze beschikbaar zijn, kunnen ze worden opgehaald uit de service
  • Het kanaal is stateloos; als een client de verzending van een resultaat mist, kan deze niet opnieuw worden afgespeeld zonder de taak opnieuw in te dienen

Gedetailleerde documentatie voor aschannel is beschikbaar bij streaminggegevens met aschannel .

App-stream opslag ( asstore )

asstore is een tijdsgebonden resultaatsopslag, waarmee klanten de resultaten van ingediende taken kunnen ophalen zodra ze beschikbaar zijn.

  • Resultaten worden gedurende een beperkte periode opgeslagen voordat ze verlopen en verwijderd zijn
  • Een resultaat mag maar één keer worden gedownload; het wordt eenmaal verbruikt verwijderd

Gedetailleerde documentatie voor asstore is beschikbaar bij het downloaden van gegevens met asstore .

Gebruikte normen

Via ricloud en zijn documentatie worden de volgende standaarden gebruikt:

  • De API gebruikt consistent datums in het ISO-8601- formaat, in de UTC- tijdzone. 24 december zou bijvoorbeeld worden uitgedrukt als 2014-12-24 17:30:00.000000 .
  • Gestructureerde gegevens geretourneerd door de componenten van ricloud gebruiken altijd JSON . Dit wordt steevast aangegeven door de application/json van het type application/json content-type.
  • Opdrachtvoorbeelden in deze documentatie worden gegeven in bash indeling, met behulp van de opdracht curl .

Hoe kunnen we helpen?

Ons ondersteuningsteam is er om u te helpen!

Onze kantooruren zijn van maandag tot vrijdag van 09.00 tot 17.00 uur GMT. De tijd is momenteel 5:47 AM GMT.

We streven ernaar om alle berichten binnen één werkdag te beantwoorden.

Ga naar het ondersteuningsgedeelte › Neem contact op met het Enterprise-team ›
Ons geweldige ondersteuningsteam

© 2008 - 2019 Reincubate Ltd. Alle rechten voorbehouden. Geregistreerd in Engeland en Wales #5189175, VAT GB151788978. Reincubate® is een geregistreerd handelsmerk. Privacy en voorwaarden. Wij bevelen 2FA aan. Gebouwd met in Londen.