<< Click to Display Table of Contents >> Navigation:  Web API > Web API Setup

 

Alvorens een externe bron via de Web API toegang kan krijgen tot de gegevens van Logicworks CRM, dienen een aantal zaken te worden ingericht. In dit hoofdstuk worden deze stappen beschreven.

 

 

1. 'Web API Token' toevoegen aan Gebruiker invoervenster

In versie 7.5.27 is een nieuw veld 'users.webapitoken' toegevoegd. In dit veld moet de Web API authenticatie token ingevoerd worden door de applicatiebeheerder. Om dit mogelijk te maken dient het veld daarom toegevoegd te worden aan het tabblad 'Extra' van de entiteit Gebruiker. Geef hierbij aan dat het veld altijd een unieke waarde moet bevatten, zodat na de Web API Authenticatie altijd duidelijk is, welke gebruiker toegang vraagt tot de dienst. Omdat de Web API Authenticatie geen onderscheid maakt tussen hoofd- en kleine letter kan voor eenduidigheid het beste de optie 'Hoofdletters' worden aangevinkt.

 

 

 

2. Aanmaken Web API gebruiker

Is het veld 'Web API Token' toegevoegd aan het venster, dan moet voor iedere externe partij, die gebruik willen maken van de Web API service, een nieuwe gebruiker aangemaakt worden. In het tabblad Autorisatie dient vervolgens aangegeven te worden welke rechten deze gebruiker heeft. Voer tenslotte in het tabblad 'Extra' bij deze gebruiker een unieke Web API Token in. Dit dient een willekeurige reeks van cijfers en letters te zijn.

 

Deze Web API Token dient de gebruiker van de Web API service mee te geven bij iedere aanroep. De webservice zal hierop controleren of deze Web API token is gedefinieerd en de gebruiker geautoriseerd is om de gevraagde gegevens te gebruiken en bij te werken. Het is dan ook belangrijk voorzichtig met de tokens om te gaan en deze slechts te verstrekken aan de betreffende externe partij.

 

 

3. HttpGet

De HttpGet opdracht dient door de externe partij te worden gebruikt om gegevens op te vragen uit de Logicworks CRM database. Alvorens de HttpGet wordt uitgevoerd door de webservice, zal deze controleren of de gebruikte API Token geldig is en de bijbehorende gebruiker wel geautoriseerd is voor het gewenste object. In het hoofdstuk Web API HttpGet wordt beschreven welke stappen moeten worden uitgevoerd in Logicworks CRM, zodat de webservice de HttpGet aanvragen op een correcte wijze af kan handelen.