Intro Releasenotes Documentatie & testen ClientID Access Token Webhooks Postman Best practices Unauthorized(401) Forbidden(403) Limiet Bereikt (429) Meldingen FAQ Terminologie Use case: bijwerken persoon Use case: niet beschikbaarheid Use case: aanbod op website Use case: inschrijving versturen  Datamodel


Postman is een handige tool wanneer je de REST API van Coachview wilt testen en debuggen. Ook voor het bouwen van een applicatie kun je Postman perfect gebruiken. In dit document vind je de basis stappen die je dient te doorlopen om dit te realiseren.
Op de website www.postman.com kun je de software downloaden.

Client_ID:
Voordat gestart kan worden met Postman, is het belangrijk om eerst een client_ID aan te maken. Hoe je een client_ID aan kunt maken kun je lezen in het artikel  Aanmaken client_ID.

Stappen:
Aanmaken Workspace
Zodra je Postman geïnstalleerd hebt kun je een workspace aanmaken. Ga hiervoor naar "Workspaces" "+ New Workspace".
Geef een name en summary in, bijvoorbeeld "Coachview workspace". Bij visibility bepaal je voor wie deze workspace beschikbaar is. Kies vervolgens voor "Create Workspace".

Aanmaken Collection
Selecteer de workspace die je aangemaakt hebt en kies voor "Create a new Collection". Geef deze een naam en de collection wordt aangemaakt.
Kies voor "Add a request.


Authorisatie instellen
Selecteer de aangemaakte collection en open tabblad "Authorization". Het type is "OAuth 2.0".

Aantal velden worden standaard gevuld zoals je hiernaast kunt zien. 


Configure New Token
Geeft een naam in voor de token. Bij "Grant Type" selecteer je dezelfde die bij het aanmaken van de client_id geselecteerd is. In de meeste gevallen is dat "Client Credentials".

Bij de "Access Token URL" geef je voor Coachview "https://training.coachview.net/auth/connect/token" in.
In de "Client ID" en "Client Secret" geef je de informatie in die je gebruikt hebt bij het aanmaken van de client. 
De scopes zijn erg belangrijk. De eerste scope is "api". Deze dient altijd toegevoegd te worden voor de correcte werking van de API. Daarna noteer je alle scopes die je wil gebruiken gescheiden door een spatie. Bijvoorbeeld "Personen.Lezen Personen.Schrijven".
Kies vervolgens voor "Get New Access Token.
Is alles correct ingevuld dan krijg je daar een bevestiging van. In het scherm daarna kies je voor "Use Token".
Let op dat je regelmatig op bewaren klikt. Bovenin het scherm zie je de Workspace staan. Wanneer deze nog niet bewaard is zie je een oranje bolletje. Kies voor "Save" of Ctrl-S.


Toevoegen request
Nadat de workspace en de connection correct ingesteld is kunnen we een request toevoegen. Aan de hand van het voorbeeld voor het lezen van personen wordt hier beschreven welke stappen je dient te doorlopen.
De eerste stap is het toevoegen van een request. Bij de collection kun je kiezen voor "Add a request".
Nadat je de naam ingegeven hebt dien je de URL in te geven voor de API. Voor personen is dat bijvoorbeeld  https://training.coachview.net/api/v1/Personen..
Vervolgens kun je kiezen voor "Send" en als alles goed ingevuld staat krijg je onderin het resultaat te zien.
Rechts in het scherm zie je de status naar voren komen. In ons voorbeeld is dat code 200.


Bijgewerkt tot en met versie 85