HulpcentrumAPI
Een API (Application Programming Interface) maakt het mogelijk dat twee applicaties met elkaar kunnen communiceren. Zo is het mogelijk om de overdracht van gegevens van systeem naar systeem mogelijk te maken. Het aanmaken van een API account in OnView staat in dit artikel beschreven.
De technische documentatie van de API staat hier https://api.onview.nl/.
Instructie aanmaken gebruikersnaam/wachtwoord API
Om externen toegang te geven tot de API moeten er drie acties uitgevoerd worden.
- Voeg een afnemer toe, dit is de partij die toegang gaat krijgen tot de API
- Voeg een gebruiker toe
- Voor de gebruiker moeten de rechten worden ingesteld
Toevoegen afnemer
Ga via het 'instellingen' menu naar het uitklapmenu 'Koppelingen' en kies het menu-item 'API'.
Je kan een nieuwe afnemer toevoegen door op het groene plus-icoon 'Nieuwe API afnemer toevoegen' te klikken. Vul vervolgens de benodigde velden in en zet de afnemer op 'actief' doormiddel van de checkbox. Hierna klik je op 'opslaan'.
Er is nu een nieuwe afnemer bijgekomen in de lijst met afnemers op het overzicht.
Gebruiker toevoegen
Klik op het groene plus-icoon naast de desbetreffende afnemer om een gebruikter toe te voegen. Er opent vervolgens een pop-up scherm:
Tabblad 'Toegang en rollen'
- Vul een naam in
- Kopieer de gegenereerde gebruikersnaam en wachtwoord, deze moeten verstuurd worden naar de afnemer
- Selecteer de rollen die deze gebruiker heeft
Tabblad 'Dossiertype'
- Selecteer de soorten dossiers waar de gebruiker toegang toe krijgt
Tabblad 'Dossiergroep'
- Selecteer de soorten dossiergroepen waar de gebruiker toegang toe krijgt
Tabblad 'Rechten'
- De API geeft verschillende soorten 'entiteiten' terug, bijvoorbeeld een Dossier of een Cliënt, per entiteit kan ingesteld worden welke data van deze entiteit je beschikbaar wilt stellen aan de gebruiker.
De gebruiker is nu aangemaakt en de gegevens kunnen verstuurd worden aan de partij die deze gebruiker zal gebruiken voor toegang tot de API.