API documentatie

Inserve is ontwikkeld vanuit het API first principe. Alle functies die worden toegevoegd worden eerst ontwikkeld in de API, waarna de front-end (de voorkant) volgt. Dat betekent dat je met een API sleutel alle acties kan uitvoeren die je ook in de applicatie kan. Dat geeft jou oneindige mogelijkheden!

API documentatie

We hebben API documentatie beschikbaar waarin uitgelegd wordt hoe je authenticeert en calls uitvoert. Deze documentatie is niet compleet. Lees hieronder hoe je de browser inspector gebruikt om alle calls te achterhalen.

Volg voor de API documentatie deze link: https://documenter.getpostman.com/view/14835414/2s935kQ6UW.

Inspector

Niet alle API calls staan in de documentatie. Om te achterhalen hoe je calls nabootst die je in de applicatie doet, volg de volgende stappen:

• Navigeer naar Inserve in je browser (in dit voorbeeld Google Chrome).
• Rechtermuis klik ergens in Inserve en kies voor 'Inspecteren' of 'Element inspecteren' of druk op Ctrl + Shift + I (Cmd + Option + I voor macOS).
• Ga naar het tabblad 'Network' en filter op 'Fetch/XHR'.
• Voor de duidelijkheid klik een keer op 'Clear network log' (het niet-parkeren symbool)
• Voer nu de actie uit in Inserve.
• Je ziet een aantal rijen aan de linkerkant er bij komen. Dit is de actie die uitgevoerd wordt, en daarna de data die ververst wordt. Die eerste is de call die je waarschijnlijk zoekt.
• Onder 'Headers' vind je de URL en methode (GET/POST/PUT/DELETE)
• Onder 'Payload' vind je de JSON die opgestuurd wordt.
• Onder 'Response' zie je wat er van de server terugkomt.

API sleutel

Klik rechtsbovenin op het profielmenu en kies API instellingen:

Klik op nieuwe sleutel genereren:

Kopieer de sleutel naar je applicatie.