API: Aanmaken Client-Id. : Coachview Helpdesk

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

Wanneer je met de REST API van Coachview aan de slag wil dan is het belangrijk dat je een client-id aanmaakt. Deze kun je dan bijvoorbeeld gebruiken bij het bouwen van een applicatie of het testen en debuggen ervan. In dit document vind je de stappen voor het aanmaken van een client-Id. LET OP: De client-Id die je via de swagger pagina aanmaakt kun je niet gebruiken buiten de swagger pagina!

Autorisatie:
Op de autorisatie pagina kun je een client-id aanmaken. In dit document gebruiken we de trainings omgeving. Wil je dezelfde stappen voor productie uitvoeren, dan dien je training te vervangen door secure. Maak een Clientid aan voor de trainings omgeving Maak een Clientid aan voor de productie (live) omgeving

Voorwaarden:
Om ervoor te zorgen dat niet iedereen zomaar client-id's aan gaat maken dien je contact op te nemen met onze support-afdeling. Zij zullen toegang geven tot de REST API. Dit kan door middel van een ticket. Indien gewenst kan er een telefonische afspraak ingepland worden met onze systeem integrator om samen de stappen te bespreken voor een succesvolle koppeling. Voordat je de client toe kunt voegen dien je in te loggen in de betreffende Coachview omgeving. In deze Coachview omgeving dien je administrator rechten te hebben (gebruikersrol 'Administrator').

Client aanmaken:
Op de autorisatie pagina staan alle cliënts die ingesteld zijn voor jullie Coachview omgeving. Wanneer je de eerste cliënt aan gaat maken, dan zie je een leeg scherm. Kies voor "Client toevoegen" wanneer je een nieuwe connectie aan wil maken.
Naam: Geef een naam aan de cliënt die je aan gaat maken. Grant type: selecteer de optie "client_credentials". Dit is de manier waarop je toegang wil krijgen tot de Coachview API. Secret: dit is het wachtwoord wat benodigd is. Zodra je deze bewaard hebt is deze niet meer zichtbaar. Zorg er dus voor dat je deze onthoudt.
Scopes: Selecteer de scopes die je wilt gebruiken. Nadat je de cliënt aangemaakt hebt kun je deze scopes nog steeds wijzigen.
Token lifetime: Geef hier in hoelang de token geldig dient te zijn. Enabled: Zet de client-id op enabled wanneer je deze wil gebruiken.
Nadat je de client-id opgeslagen hebt zie je in het overzicht de naam, type en client-id. Deze kun je in combinatie met de secret gebruiken in bijvoorbeeld Postman.

Aanvragen tokens:
Bij het aanmaken van een client-id geef je aan wat de "Token Lifetime" dient te zijn. Daarmee geef je aan hoe lang het token geldig blijft. Iedereen die beschikking heeft over dit token kan verbinding maken met de API en heeft daarmee dus toegang tot de data. Ga dus altijd zorgvuldig om met deze tokens en deel deze nooit zomaar met anderen. Wij adviseren dan ook om de lifetime zo laag mogelijk in te stellen. Vraag pas een nieuw token aan vlak voordat het huidige token gaat verlopen.