Overzicht

bijgewerkt

Het is de documentatie voor de derde versie van de ricloud- API van Reincubate. De API biedt gebruikers een mechanisme waarmee ze via asrelay eenvoudig toegang hebben tot app-gegevens uit verschillende databronnen, waaronder Apples iCloud en lokale iTunes-back-up.

Voor productinformatie, zie de ricloud-productpagina .

Kernbegrippen

Voordat u zich gaat verdiepen in het gedeelte 'Aan de slag', is het handig om bekend te zijn met een handvol termen en concepten die overal worden gebruikt.

Service

Een service beschrijft een verzameling gegevensbronnen die beschikbaar zijn via de API. Dit omvat services van derden, zoals iCloud- of Reincubate-producten, zoals asrelay .

Verschillende services hebben verschillende vereisten voor bepaalde bronnen in de API en wijzigen ook de algehele levenscyclus van API-objecten. De payload die nodig is om een sessie voor de iCloud-service te maken, verschilt bijvoorbeeld van de behoefte aan de asrelay- service.

Bron

Dit zijn specifieke gegevensbronnen binnen een service. Een iCloud-account is de primaire bron van de iCloud-service, terwijl een asrelay- clientinstantie de primaire bron van de asrelay- service is.

In veel gevallen heeft een service een hiërarchie van bronnen die afzonderlijk kunnen worden getarget. De iCloud-service heeft bijvoorbeeld accountbronnen en apparaatbronnen.

Gebruiker

Een gebruiker moet altijd de eindgebruiker vertegenwoordigen die om gegevens vraagt. In veel gevallen zal dit een gebruiker van uw applicatie zijn.

Sessie

Een sessie vertegenwoordigt de toegang tot een specifieke bron en is nodig om via de API informatie of gegevens van de bron op te halen.

Het maken van een sessie is het equivalent van een 'login' in een iCloud-account of 'koppelen' met een asrelay- clientinstantie.

De API voert het sessie-initialisatieproces asynchroon uit via een taak. Dit betekent dat de oproep om een sessie te maken direct zal terugkeren, maar de sessie is pas klaar voor gebruik als de initialisatie is voltooid.

poll

Peilingen zijn hoe gebruikers via de API gegevens kunnen opvragen. Een actieve sessie tegen de gerichte bron is nodig om een peiling in te stellen.

Alle peilingen worden asynchroon verwerkt via een of meer taken en de resultaten worden gepubliceerd naar cloudopslagbakken die zijn geconfigureerd in uw organisatie.

Taak

Dit zijn de onderliggende brokken werk uitgevoerd door de API. Wanneer een sessie wordt gemaakt, wordt er ook een taak gecreëerd om initialisatie tegen externe services uit te voeren. Wanneer een peiling wordt gemaakt, maakt deze ten minste één taak voor het ophalen van gegevens.

Sleutelbegrippen

Middelen

De API is georganiseerd rond een set bronnen die wordt beschreven in de API-resourcereferentie. Via deze bronnen kan een client van de API: hun API-configuratie aanpassen, de toegang tot de gegevensbron initialiseren en gegevens uit deze bronnen ophalen.

Asynchrone verwerking

De API vertrouwt op asynchrone bewerkingen voor het instellen van sessies tegen services van derden en gegevensverwerking. Dit geeft hem de mogelijkheid om een grote hoeveelheid gegevensvraag te beheren terwijl hij verantwoordelijk omgaat met externe services. Het biedt ook extra flexibiliteit om te reageren op fluctuaties in responstijden of verslechtering van diensten van derden.

Opslag emmer publiceren

De gevraagde gegevens van de API worden rechtstreeks in de bucket van een klant op Google Cloud Storage of Amazon S3 gepubliceerd. Dit helpt problemen met betrekking tot het schalen van gegevensaflevering te minimaliseren en maakt ook snellere gegevensherstel mogelijk omdat publiceren minder snel een knelpunt wordt.

Webhookmeldingen

De melding dat de asynchrone bewerking is voltooid, wordt afgehandeld via een webhook-mechanisme, waarbij gebeurtenissen via standaard HTTP-aanvragen naar de server van een client worden verzonden. Deze gebeurtenissen bevatten informatie over het vinden van gevraagde gegevens in de emmer van een klant, zodat de klant kan beslissen wanneer en hoe deze moet worden gebruikt.

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

Kunnen we dit artikel verbeteren?

We horen graag van gebruikers: Stuur ons een e-mail, laat een reactie achter of stuur een tweet @reincubate?

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