protocollen

Asynchrone verwerking

De API maakt voor alle peilingen gebruik van asynchrone verwerking. Dit omvat interacties met externe services, zoals de iCloud, omdat deze afhankelijk van de verwerkingssnelheid enkele seconden of minuten in beslag kunnen nemen.

Een aantal standaardbroninteracties kunnen asynchrone 'bijwerkingen' veroorzaken die worden uiteengezet in de API-referentiedocumentatie. Deze zijn meestal bedoeld voor het uitvoeren van geldigheidscontroles of andere hulpprogramma's.

De asynchrone basis van de API helpt ook de interface voor periodieke polling te vereenvoudigen die vanuit de API wordt geactiveerd. Dit betekent dat het ophalen van gebeurtenissen en resultaten hetzelfde is, of dit nu rechtstreeks met de API is of via geplande peilingen.

Wacht op antwoord

De API ondersteunt het wachten op de voltooiing van asynchrone taken via langlevende aanvragen om de behoefte aan polling te minimaliseren en de totale responstijd voor eindgebruikers te verminderen. Om deze functionaliteit in te schakelen, voegt u de Ricloud-Await HTTP-header toe aan uw verzoeken met de gewenste time-outwaarde. De huidige maximale time-outwaarde is 10 seconden.

Ricloud-Await: 3

Deze functionaliteit wordt ondersteund op de volgende eindpunten:

• Maak sessie POST /sessions
• Configuratie van testopslag POST /configs/storage/{storage_config ID}/test
• Test webhook config POST /configs/webhook/{webhook_config ID}/test

Versleutelde publicatie

Alle resultaten die door de API worden gepubliceerd, kunnen worden gecodeerd met een openbare RSA-sleutel in de hele organisatie.

Eindgebruikersproeven

Er is een proefmodule voor eindgebruikers beschikbaar voor gebruik door de klant. Dit kan gebruikt worden om een "teaser" van data terug te sturen naar potentiële eindgebruikers. De module biedt een feed van de laatste vijf berichten samen met een laatste locatie en een overzicht van andere beschikbare berichten.

Het gebruik van dit mechanisme kan kosteneffectiever zijn dan het gebruik van een volledige sleutel voor proeven met eindgebruikers.

Analyse en rapportage

De iCloud-service van de ricloud biedt een aantal extra functies rond analyse en rapportage.

Er zijn twee modules beschikbaar voor bedrijven: basisgebruik van de app, die laat zien welke apps op een bepaald moment op een bepaald iOS-apparaat zijn gebruikt en geavanceerd app-gebruik, dat aanvullende informatie biedt, zoals het aantal sessies, de duur van de sessies, enzovoort. Meer informatie over deze modules is op aanvraag beschikbaar.

Forensisch onderzoek en herstel

Forensische verwijdering en herstelfunctionaliteit is beschikbaar voor een aantal modules zoals hieronder aangegeven, inclusief de berichten (SMS, MMS en iMessage) en iCloud-fotobibliotheekmodules.

Reincubate heeft een aantal aangepaste forensische tools die op verzoek kunnen worden toegepast op andere modules, waaronder WhatsApp en WeChat.

Kenmerktypes

Datum Tijd

Datetime-kenmerken worden opgemaakt volgens de ISO8601-specificatie. De API retourneert alle datetime-kenmerken met de UTC-tijdzone, dwz "2018-08-22T10:25:05Z" .

Met een aantal eindpunten voor date_created kan worden gefilterd op datetime-kenmerken, zoals date_created . Om te filteren met behulp van meer handige operatoren, prefix de datetime filterwaarde met een van lt_ , lte_ , gt_ of gte_ .

Timedelta

Attributen van het timedelta-type zijn altijd in seconden, tenzij anders aangegeven.

Paginering

De API maakt gebruik van op cursor gebaseerde paginering. Voor alle oproepen van het lijsttype gelden de aanvullende parameters:

• limit om het maximale aantal items te specificeren dat moet worden geretourneerd. Standaardwaarde is 10, max. Waarde 1000.
• after_id om de ID op te geven van waaruit de lijst moet worden gestart.
• before_id om de resource-ID op te geven waarvan de vermelding moet worden gestopt.

Lijstreacties omvatten teruggestuurde bronnen onder het data attribuut. Ook opgenomen is het helper attribuut has_more wat has_more of meer bronnen kunnen worden vermeld die niet zijn opgenomen vanwege de limiet.

Tarieflimieten

Verzoeken om de API kunnen worden beperkt door een standaardtarieflimiet of door een limiet voor aanvragen tijdens de vlucht. De eerste wordt gebruikt om misbruik van API-bronnen op grote schaal te minimaliseren, terwijl de laatste wordt gebruikt om afzonderlijke resource-instanties te beschermen.

Voorbeeld van snelheidsbeperking: het aantal verzoeken aan de API van een enkele organisatie is beperkt tot 10.000 verzoeken per uur. Dit helpt beschermen tegen kwaadaardige of toevallige spikes in het verkeer.

Voorbeeld van een in-flight limiet : aan een instantie van een bronbron kan geen taak worden gemaakt als een andere taak al wordt verwerkt. Hiermee wordt de integriteit van de sessie behouden, het verkeer naar externe services tot een minimum beperkt en

Versioning

Hoewel de belangrijkste releases van de API een grotendeels semantisch versiebeheerschema hebben (dwz v1 , v2 , v3 ), zijn alle wijzigingen die in de v3- versie van de API worden doorgevoerd, geaggregeerd volgens een kalenderversieschema (ie 2018-11-06 ). De versie kan globaal voor uw organisatie worden ingesteld of per aanvraag worden opgegeven via de Ricloud-Version de Ricloud-Version .

Verwijderbare bronnen

De meeste bronnen zijn niet-verwijderbaar, wat betekent dat ze alleen kunnen worden gedeactiveerd door de eigenaarorganisatie of worden geblokkeerd door een API-beheerder.