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


Coachview is een online softwarepakket voor cursusadministratie. Naast het registreren van bijvoorbeeld opleidingen, bedrijven en personen en inschrijvingen in Coachview is het ook mogelijk om data uit Coachview te ontsluiten of data in Coachview, denk aan een inschrijving via de website, te plaatsen. Dit doe je met behulp van onze API (Application Programming Interface), een verzameling instructies op basis waarvan applicaties en apparaten onderling kunnen praten.


Tip: We zijn gestart met het verzorgen van een kosteloze workshop Coachview API's. Wil jij de volledige controle over jouw Coachview-gegevens en de mogelijkheid om ze naadloos te integreren met andere systemen? Dan is de Workshop Coachview API de perfecte gelegenheid om jouw vaardigheden naar een hoger niveau te tillen. Deze workshop, gehouden op het Coachview-kantoor in Uden, biedt een diepgaand inzicht in de Coachview API en stelt je in staat om de kracht van gegevensintegratie volledig te benutten.
Ben jij een gebruiker van Coachview of een webbouwer die de koppeling met Coachview moet verzorgen? Schrijf je dan in voor deze workshop via ons Opleidingsportaal.


Tip: Meer weten over aanpassingen aan onze API's? De releasenotes vind je hier.


Mogelijkheden:
Coachview heeft twee omgevingen beschikbaar om jouw API aan te koppelen. De productieomgeving (live) en de trainingsomgeving (speeltuin).

In de trainingsomgeving kun je jouw API ontwikkelen en testen. Tests die je hier uitvoert hebben geen invloed op de live data. Let op! Iedere 4 weken wordt de trainingsomgeving overschreven met gegevens uit de productieomgeving, waarbij niet alle gegevens één op één worden overgenomen. Dit gebeurt bij het installeren van een nieuwe release in deze omgeving. Wil je weten wanneer nieuwe releases worden geïnstalleerd? Klik hier voor de installatieplanning. Wil je weten welke gegevens niet worden meegenomen? Klik dan hier voor een overzicht.

De productieomgeving gebruik je om actuele data op te halen of weg te schrijven. Nadat de koppeling met de API in de trainingsomgeving succesvol getest zijn, kun je aan de slag in jouw productieomgeving.

De API wordt aangeboden op basis van een 'Fair use policy'. Dat betekent dat jouw gebruik van de API de prestaties voor andere klanten niet mag beïnvloeden. Het is belangrijk om goed na te denken welke endpoints er nodig zijn om het gewenste resultaat te bereiken. Heb je hier vragen over of wil je graag dat wij met je meedenken? Neem dan contact met ons op.

Documentatie:
Omdat er een verschil kan zijn tussen de trainingsomgeving en de productieomgeving hebben we voor beide omgevingen een aparte documentatiepagina gemaakt. Nieuwe endpoints en aanpassingen aan bestaande endpoints zullen allereerst in de trainingsomgeving toegevoegd worden. Nieuwsgierig en meer weten? Klik dan hier voor de documentatiepagina. Je maakt daarbij gebruik van Swagger. 

Autorisatie:
Voordat je aan de slag gaat is het belangrijk om te weten welke rechten je nodig hebt en hoe je ervoor kunt zorgen dat je de endpoints in de twee verschillende omgevingen kunt testen met Swagger of gebruiken via Postman.
Om de verschillende endpoints via Swagger te testen of via Postman te gebruiken heb je een Coachview gebruikersaccount nodig in de trainingsomgeving en/of de live-omgeving. Afhankelijk van de endpoints die je gaat testen heb je administrator rechten en lees- en schrijfrechten nodig op verschillende modules. Welke modules noodzakelijk zijn hangt af van de endpoints die wilt gebruiken. Voor de live-omgeving zijn aan een gebruikersaccount maandelijkse licentiekosten verbonden, afhankelijk van de ingestelde modules.

PublicId:
Voor het ophalen van informatie uit dossiers kun je gebruik maken van een publicid. Dit is een veilig en niet te herleiden nummer.

Maak je nog gebruik van onze SOAP webservices, dan ben je gewend gebruik te maken van interne id's wat minder veilig is. Aan te raden dus om over te stappen naar onze REST API. Met behulp van een verstaal service kun je de vertaling tussen de interne id en de PublicId maken.

Kosten:
Er zijn maandelijkse kosten voor het gebruik van onze API.

Vragen:
Bij vragen kun je contact opnemen met onze supportafdeling, stuur een e-mail naar support@coachview.net.


Let op: het wordt nooit mogelijk om in de live-omgeving met Swagger te testen! De Swagger pagina van de trainingsomgeving kan anders zijn dan de Swagger pagina van de live omgeving, omdat nieuwe toevoegingen eerst op training beschikbaar komen.


Bijgewerkt tot en met versie 86