Overzicht
Dit is de documentatie voor Reincubate's ricloud API. De API biedt gebruikers toegang tot hun eigen gegevens in Apple's iCloud en lokale iTunes-back-ups via de Reincubate Relay-app.
Voor productinformatie zie de ricloud API productpagina .
Sleutelbegrippen
Middelen
De API is georganiseerd in een set bronnen. Een client kan deze maken, ophalen, bijwerken en vernietigen (CRUD) om bewerkingen op de API te configureren, activeren en bewaken. Zie de API-bronreferentie voor meer details.
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
Melding van voltooiing van asynchrone bewerking wordt afgehandeld via webhooks, waarbij gebeurtenissen via standaard HTTP-verzoeken naar de server van een klant worden verzonden. Deze gebeurtenissen bevatten informatie over waar de gevraagde gegevens binnen de bucket van een klant kunnen worden gevonden, zodat de klant een beslissing kan nemen over wanneer en hoe deze te gebruiken.
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 dienst. Een iCloud-account is de primaire bron van de iCloud-service, terwijl een Reincubate Relay-app-instantie de primaire bron is van de Reincubate Relay-service.
Gebruiker
Een gebruiker vertegenwoordigt de eindgebruiker die gegevens opvraagt. In veel gevallen zal dit een gebruiker van uw applicatie zijn.
Sessie
Een sessie vertegenwoordigt toegang tot een specifieke bron en er is er een nodig om informatie of gegevens uit de bron op te halen via de API.
Een sessie maken is het equivalent van een 'login' op een iCloud-account of 'koppelen' met een Reincubate Relay-app-instantie.
De API voert het sessie-initialisatieproces asynchroon uit. Dit betekent dat de oproep om een sessie te maken onmiddellijk terugkeert, maar dat de sessie pas klaar is voor gebruik als de initialisatie is voltooid.
poll
Peilingen zijn hoe gebruikers gegevens kunnen opvragen via de API. Een actieve sessie tegen de beoogde bron is nodig om een poll te creëren.
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 delen van het werk dat door de API wordt uitgevoerd. Wanneer een sessie wordt aangemaakt, wordt er ook een taak aangemaakt om de initialisatie tegen externe services uit te voeren. Wanneer een peiling wordt gemaakt, wordt er ten minste één taak gemaakt om het noodzakelijke werk uit te voeren.
Resultaat
Een resultaat is een verwijzing naar gegevens of een bestand dat naar de opslagbucket van een klant is gepubliceerd.
