In dit artikel wordt beschreven hoe de REST API van Apployed gebruikt kan worden. De REST API is bedoeld om data uit het systeem te kunnen inlezen in een andere applicatie. De REST API is beveiligd met een sleutel.
Gebruik van de REST API
Onder de configuratie dient er allereerst een nieuwe sleutel toegevoegd te worden. Dit kan je toevoegen onder Configuratie > Naam Omgeving > Externe API. Klik op de drie puntjes > Sleutel toevoegen. Geef hier een naam en taal in. Hierna wordt de ClientId en ClientSecret getoond.
Let op: sla deze gegevens op voordat je op Sluiten klikt.
Stel hierna in welke datasets deze sleutel mag uitlezen. Download via hier het overzicht van alle beschikbare datasets.
Data uitlezen
Er zijn drie types die gebruikt kunnen worden in de aanroep:
- Bulk: dit is een dump van alle data
- Range: hier moet je een start- en einddatum meegeven
- Reference: hier moet je een peildatum meegeven
Bij de aanroep geef je in de URL via de parameters op welke view je wilt uitlezen en eventueel de datumselectie:
https://externalapi.apployed.nl/v1/view/Reference?name=salfuncties_peildatum&reference=2023-01-01
Let op: je kan maximaal 6 keer per 15 minuten een aanroep doen.
Hieronder staan de drie voorbeelden beschreven vanuit Postman. Voordat je een aanroep kan doen dienen wij jullie IP adres te whitelisten. Geef het IP adres door via apployed@bcs.nl en je ontvangt een bericht van ons zodat deze is toegevoegd.
Voorbeeld aanroep 1: Bulk werknemers
Maak een nieuw verzoek aan en geef de URL in:
https://externalapi.apployed.nl/v1/view/Bulk?name=werknemers
Stel bij de Authorization het Type in op Basic Auth en vul de Username en Password in. De Username = ClientId en het Password = ClientSecret.
Voorbeeld aanroep 2: Range projecturen
Geef nu aan dat het om een Range gaat en geef de startdatum en einddatum op. Bijvoorbeeld: https://externalapi.apployed.nl/v1/view/Range?name=projecturen&start=2022-01-01&end=2023-08-01
Voorbeeld aanroep 3: Reference salfuncties_peildatum
Geef nu aan dat het om een Reference gaat en geef de peildatum in. Bijvoorbeeld:
https://externalapi.apployed.nl/v1/view/Reference?name=salfuncties_peildatum&reference=2023-01-01