API

Laatst bijgewerkt: 19 december, 2024

Madaster API

Het Madaster API endpoint kan worden gebruikt voor interactie met het Madaster Platform en zijn bronnen. Deze API dekt nog niet alle functionaliteit van het platform, raadpleeg hiervoor de OpenAPI documentatie.

Blijf op de hoogte van updates

Door aan te melden op de API nieuwsbrief (in het Engels) blijft u op de hoogte van de laatste wijzigingen.

Subscribe to Madaster API updates

* indicates required

Token

Om toegang te krijgen tot de API, heeft u een autorisatie token nodig. Als u deze nog niet heeft, zie dan het hoofdstuk over Autorisatie hieronder. Het token moet worden verzonden als een header met de naam ‘X-API-Key’, om toegang te krijgen tot de gewenste bronnen.

Autorisatie

Om toegang te krijgen tot de bronnen van deze API, heeft u een API token nodig. Dit token moet worden toegevoegd aan het verzoek in de X-API-Key header. Om een API token te verkrijgen, dient u een token toe te voegen in het Madaster Platform, of uw account manager te vragen dit voor u te doen. Dit geeft u toegang tot de middelen en de daaraan gekoppelde entiteiten.

Add a token to a account, folder, building or database

  • Ga naar de resource pagina en klik op het Gebruikers tabblad

  • Klik op de API Token toevoegen knop

  • Voer een naam in voor dit token, kopieer de gegenereerde sleutel (1), kies een toestemmingsniveau en een vervaltijd, en sluit af door te klikken op de knop Toevoegen (2)

Versions

De API wordt voortdurend verbeterd, dus naarmate de tijd vordert, worden meer versies aan de interface toegevoegd. Raadpleeg de OpenAPI documentatie om te vinden welke versies welke API-aanroepen ondersteunen. Het wordt aangeraden om altijd de laatste beschikbare versie te gebruiken voor een API verzoek; maar de oude versies zullen nog enige tijd beschikbaar blijven voor legacy doeleinden. Om een API versie te selecteren, voeg de versie tag toe aan het API eindpunt. Voor versie 3.0 bijvoorbeeld, gebruik https://api.madaster.com/api/v3.0

Examples

In de Github repository kunt u enkele voorbeelden vinden over hoe te communiceren met de API in verschillende programmeertalen.