Beheer
Met de OData-API bieden wij de mogelijkheid om jullie eigen data op een andere locatie te publiceren. In LIFT kan dit ingericht worden in de ‘API Beheer’-kaart welke gevonden kan worden door op de startpagina in de ‘Acties…’ zoekbalk te zoeken op ‘API’. Gebruikers met recht op die kaart kunnen deze dan starten. De OData inrichting is te vinden op het gelijknamige tabblad.
Toegang
Software welke OData ondersteund zal automatisch ontdekken welke gegevens beschikbaar zijn op het adres vermeld in het blok ‘Algemeen’. Software welke dat niet kan, kan direct linken naar het specifieke gegeven, zie OData. Indien ingesteld, mogen gegevens via twee methodes benaderd worden: via een globale sleutel aangemaakt in het blok ‘Authenticatie’ of via een unieke sleutel per gegeven aangemaakt in het blok ‘Gepubliceerde gegevens’
Gegevens
Gegevens kunnen worden toegevoegd via de rapporten van LIFT welke de OData-API ondersteunen. Deze zijn te vinden achter de ‘Voeg een rapportage toe’-knop in ‘Ingeroosterde rapporten’. Een goed rapport om mee te beginnen is ‘Overzicht van gegevens’. Daarmee kunnen basislijsten op de API gezet worden. Berekende gegevens zijn met het ‘Uren en omzetrapport’ te ontsluiten.
Best practises
Een API opzetten in LIFT is een uitdagende klus. Voor een goede basis is het nuttig een dagdeel technisch consult af te nemen. In een interactieve sessie wordt aan de hand van de specifieke wens een basisopzet gemaakt. Daarbij wordt uitgelegd hoe gegevens het beste op de API gezet kunnen worden. Ook de verschillende valkuilen en bijzondere mogelijkheden worden toegelicht. Deze sessie is nuttig voor functionele beheerders en dataspecialisten.
Fair use
De OData-API van LIFT is een gratis dienst. Om te voorkomen dat de LIFT omgeving wordt overbelast is het gebruik gelimiteerd. De limieten zijn zo gekozen dat men er bij normale belasting geen rekening mee hoeft te houden. De api wordt elke nacht ververst. Het is dus niet nodig om meerdere malen per dag dezelfde data op te halen. Het is aan te raden om per client maar 1 dataset tegelijk op te vragen De beheerder is geheel vrij om alles naar eigen inzicht in te richten en heeft hiervoor krachtige middelen beschikbaar. Mocht dit toch problemen geven voor de LIFT omgeving, kan LIFT ingrijpen door gegevens en/of de OData-API uit te schakelen. Het oplossen van mogelijke problemen wordt verrekend. Daarom is het verstandig een start te maken via ‘Best practises’.
Voorbeeld
Zo kan je gefactureerde omzet, klantgegevens en projectgegevens op de API zetten. Nadat PowerBI, Qlik of Tableau verbinding heeft gemaakt met deze gegevens, kan je visualisaties maken voor omzet per klant of omzet per project. Ook is het mogelijk een lijst van vacatures op de API te zetten, waarna jullie eigen websitebouwer via PHP hiermee een vacaturepagina maakt.