Aan de slag met de APIboard-API

Wat kun je met de API

Met de APIboard-API haal je de data op die je via je koppelingen hebt verzameld, plus de tabellen die je zelf in de Datawerkbank hebt gemaakt. Zo bouw je eigen integraties, exports of rapporten, bijvoorbeeld in Power BI, Excel of een eigen script. De API is alleen-lezen: je haalt data op, je schrijft er niets mee terug.

Basis-URL

Alle aanvragen gaan naar https://app.apiboard.nl. Een tabel van een koppeling haal je op via /api/v1/<koppeling>/<tabel>, een eigen tabel via /api/v1/datawerkbank/<naam>. De beschikbare koppelingen en tabellen, met hun velden, staan onder Koppelingen.

In drie stappen je eerste aanvraag

1. Koppel minstens één bron in APIboard, zodat er data is om op te halen.
2. Maak een API-sleutel aan, zie Authenticatie.
3. Stuur een aanvraag, zie Een aanvraag opbouwen.

Wat je verder moet weten

• Grote tabellen komen in pagina’s binnen: Paginering.
• Wil je alleen wat er sinds je vorige run is veranderd: Incrementeel ophalen.
• Rapporteer je in Power BI: Power BI koppelen.
• Per pakket gelden gebruikslimieten.
• Gaat een aanvraag mis, dan helpt Foutafhandeling.

Onze tip: begin met een kleine aanvraag, bijvoorbeeld ?limit=5, zodat je snel ziet of je sleutel en je aanvraag kloppen voordat je een volledige integratie bouwt.