Beste praktijken (v2)

bijgewerkt

Algemeen

Er zijn een aantal praktische tips voor gebruik om optimaal gebruik te maken van de Reincubate Cloud Data API.

  • Maak gebruik van deze documentatie. Veel van de veelgestelde vragen worden beantwoord in deze materialen en de documentatie wordt regelmatig bijgewerkt.
  • De API-statuspagina kan worden gebruikt om zich aan te melden voor updates over elk gepland of urgent API-onderhoud.
  • Cliënten die profiteren van een Slack-integratiekanaal, worden meestal sneller live.
  • De Open Source-client biedt een volledig voorbeeld van een integratie met de ricloud- service, en als u dat onderzoekt (of code opnieuw gebruikt), kunt u tijdens de integratie veel werk besparen.
  • Profiteer van de nepgegevens bij het testen en integreren, maar onthoud dat echte gegevenstoegang langzamer kan zijn.
  • Volg de praktische tips voor beveiliging en privacy en bewaar geen referenties voor eindgebruikers. Gebruik in plaats daarvan het tokenisatiesysteem .
  • Codeer de taakinzending of de eindpunten van de resultaten in aanvragen niet hard: hoewel ze vaak dezelfde waarde hebben, kan de API ze van tijd tot tijd variëren.
  • Genereer niet meer taken dan nodig: het opvragen van back-upupdates is bijvoorbeeld niet meer dan een paar keer per dag onnodig, en er kan veel worden gedaan om hier een nauwkeurig schema voor op te stellen. De API is in staat om een groot aantal taken uit te voeren en veel gegevens te genereren in een korte tijd, en met name bij het gebruik van aschannel moeten klanten op hun hoede zijn om meer te vragen dan ze gemakkelijk kunnen consumeren.
  • Reincubate beschouwt het als een goede gewoonte om rechtstreeks contact op te nemen met rekeninghouders op het moment dat hun accounts voor het eerst worden benaderd en vervolgens doorlopend om ervoor te zorgen dat ze op de hoogte zijn van de activiteiten van de klant. Zie privacy verbeteren voor meer details.
  • Klanten met vereisten voor regelmatige controle van polls moeten asmaster evalueren in plaats van asapi .

? Ondersteuning en servicestatus

Servicestatus en onderhoudskennisgevingen

Reincubate onderhoudt een statuspagina op status.reincubate.com . Op de statuspagina's kunnen gebruikers zich abonneren op updates. Updates worden verzonden voor gepland of noodonderhoud.

Directe ondersteuning

Klantondersteuning is beschikbaar via e-mail op ent- support@reincubate.com en via privé Slack-integratiekanalen. Klanten kunnen contact opnemen met het ondersteuningsteam om de configuratie van het integratiekanaal te regelen.

Problemen melden

Bij problemen met de API kan het de resolutie versnellen als het ondersteuningsteam op de hoogte is van de X-RI-Build HTTP-header die is ontvangen in de probleemrespons. De X-RI-Build HTTP-header ziet er zo uit:

X-RI-Build: 1.0-pre-ios9-395-g126226b; nj-api-7

Wanneer trending-probleemrapporten worden ingediend, zullen de ondersteuningsengineers altijd om de curl-opdrachten vragen die kunnen worden gebruikt om replicatie van het probleem aan te tonen, en voor de reactie van de server.

? Het vergrendelen van iCloud-accounts minimaliseren

Apple vergrendelt iCloud-accounts met verschillende frequenties op basis van een grote en dynamische reeks criteria. In grote lijnen vallen deze in drie categorieën:

  1. De manier waarop een stukje technologie communiceert
  2. De aard van de infrastructuur die wordt gebruikt om te communiceren
  3. Het ritme, de patronen en de frequentie waarmee die technologie communiceert

Reincubate's Cloud Data API adresseert alle drie als ze evolueren. De eerste wordt afgehandeld door de eigen code achter de API en de tweede door de omvangrijke en complexe infrastructuurstack die Reincubate onderhoudt. Wanneer de API echter rechtstreeks met asapi wordt beheerd , kunnen klanten moeite hebben om # 3 te beheren op schaal of in gebruik-gevallen waarvoor een regelmatige polling vereist is.

Licht of eenmalig gebruik met asapi leidt waarschijnlijk niet tot vergrendeling, maar reguliere toegang kan het doen als het niet goed wordt beheerd. De asmaster- service is ontworpen om dit voor clients te beheren en wordt aanbevolen voor directe toegang tot asapi voor deze use-cases.

? Mock-gegevens voor integratie en testen

Apple iCloud-service voorbeeldgegevens

Een rijk onecht account van Apple iCloud-servicegegevens wordt verstrekt john.appleseed@reincubate.com account john.appleseed@reincubate.com , dat toegankelijk is met het wachtwoord joshua . De gegevens worden verstrekt om snel integraties met de API te testen.

Toegang tot dit account is niet factureerbaar en de voorbeeldgegevens worden rechtstreeks van de servers van Reincubate afgeleverd, waardoor de responstijd aanzienlijk wordt versneld.

FAQ

Bewaart de API feed- of bestandsgegevens?

Nee, niet bij gebruik met aschannel , omdat feed- en bestandsgegevens worden gestreamd naar clients en niet worden bewaard in de RI-stack. Bij gebruik van asstore wordt informatie opgeslagen in emmers totdat ze worden opgehaald. Het kanaal wordt echter aanbevolen voor bijna alle gebruiksscenario's.

In sommige gevallen zal de API wat metadata behouden, vooral waar de planner van asmaster een rollend venster met metadata bijhoudt om te helpen nauwkeurige polling-vensters te berekenen.

Hoe vraag ik feeds en bijlagen aan bij asmaster ?

Dat is niet nodig. Eenmaal geabonneerd op accounts of apparaten, worden gegevens automatisch via aschannel verstrekt zodra deze gereed is.

Hoe vertel ik asmaster om mij meer of minder modules te geven?

Het is niet nodig om programmatisch iets te doen. De belangrijkste configuratie van een client bevat gegevens over de modules waartoe ze toegang hebben en alle modules worden gebruikt bij het streamen van gegevens. Nadat het provisioningteam een clientsleutel heeft bijgewerkt, wordt de nieuwe moduleset weergegeven in feeds.

Op welke frequentie peilt asmaster ?

Het schuifregelaarmechanisme van asmaster streeft naar gegevens die zijn onderworpen aan twee doelen: de best- pollingfrequentie voor een bepaalde service niet overschrijden en gegevens leveren die zo dicht mogelijk bij zijn wanneer deze beschikbaar worden gesteld. De planner zal altijd prioriteit geven aan het niet schaden van de account of het overtreden van de beste praktijken voor het verkrijgen van nieuwe gegevens.

Bij gebruik van real-time gegevens kan dit betekenen dat de gegevens worden geleverd met real-time, near-time of batch-frequentie. Bij batchgegevens werkt de planner zelf in batchmodus.

De regels achter de frequentieselectie is dynamisch.

Welke limieten gelden er voor een proefsleutel?

Beperkingen van de proefsleutel kunnen variëren afhankelijk van de aard van de sleutel. Ze kunnen worden beperkt door:

  • Aantal apparaten of accounts toegankelijk via de sleutel
  • Ondersteuning voor niet-2FA / 2SV-accounts (bijv. Proefgebruikers kunnen om redenen van compliance worden belet toegang te krijgen tot niet-2FA-accounts)

Waar wordt de API gehost?

Zie de opmerking over hosting en connectiviteit .

Waarom zie ik geen gegevens voor het gegevenstype xyz?

Als u een leeg antwoord van de ricloud ziet en geen fout, betekent dit dat de gegevensbron leeg was. Voer de hieronder vermelde stappen uit om er zeker van te zijn dat de gegevens beschikbaar zijn en klaar zijn om door ricloud opgehaald te worden.

  1. Zorg ervoor dat de bijbehorende instelling voor het gegevenstype is ingeschakeld.

    • Voor gegevenstypen waarbij de bron een iOS-apparaatback-up is, betekent dit het inschakelen van iCloud-back-ups in Settings > [user name] > iCloud > iCloud Backup > iCloud Backup en ervoor te zorgen dat het apparaat ten minste één keer is geback-upt. Een back-up kan handmatig worden geactiveerd door op de knop Back Up Now op het bovengenoemde scherm te drukken.
    • Voor realtime en near-time gegevenstypes zijn de instellingen meer specifiek voor de service die verantwoordelijk is voor het synchroniseren van de gegevens met iCloud. De instelling die aan Zoek mijn iPhone is gekoppeld, vindt u bijvoorbeeld onder Settings > [user name] > iCloud > Find My iPhone > Find My iPhone . De bijbehorende instelling wordt weergegeven naast andere gegevenstype-eigenschappen in het gedeelte met invoermodules .
  2. Zorg ervoor dat het apparaat de mogelijkheid krijgt om gegevens te synchroniseren.

    • Voor back-upfeeds van iCloud moet het apparaat zijn aangesloten en vergrendeld om een automatische iCloud-back-up te kunnen maken. U kunt op elk gewenst moment nog steeds een handmatige back-up activeren.
    • Voor gegevenstypes in realtime en in de buurt van de tijd variëren de synchronisatietriggers afhankelijk van het serviceontwerp. In het algemeen kan het ongeveer 4-6 uur duren voordat een deel van de langzamere synchronisatieprocessen is uitgevoerd.

afkeuring

  • Vanaf het eerste kwartaal van 2017 kan de verouderde ricloud 1.x als verouderd worden beschouwd, hoewel hij nog steeds volledig wordt ondersteund door een adapter die zijn verkeer hervormt en naar asapi leidt .

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 3:27 PM 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.