Een API-gebruiker is een specifieke gebruiker die wordt aangemaakt om de API-koppeling tussen CASH en externe partijen mogelijk te maken. Deze gebruiker wordt bewust niet gebruikt voor dagelijkse handelingen in CashWeb, maar uitsluitend voor API-requests.
API gebruiker instellen
Volg onderstaande stappen voor het instellen van een API-gebruiker is CASHWeb;
- Ga naar het CashWeb en login met je relatienummer, e-mailadres en wachtwoord;
- Selecteer de gewenste administratie;
- Klik op de tandwiel rechtsboven in het scherm en selecteer vervolgens "Gebruikersoverzicht";
- a - Wanneer je een bestaande gebruiker toe wilt voegen als API-gebruiker, ga dan meteen door naar stap 5;
b - Om een nieuwe gebruiker toe te voegen, klik je in het menu op de knop 'Maak aan'. Je geeft voor deze specifieke gebruiker een naam en unieke login(e-mail)adres op. Klik op de groene knop 'Maak aan' om de gebruiker toe te voegen.
Activeer de nieuwe gebruiker door één keer in te loggen op CashWeb met het API-gebruikersaccount. - Ga terug naar het gebruikersoverzicht en selecteer de gebruiker waarmee de API-koppeling gemaakt gaat worden met 'Wijzig';
- Selecteer tabblad 'Api' . De overige instellingen voor de API-gebruiker laat je leeg, omdat deze niet van belang zijn voor de API-koppeling;
- Activeer de vink API gebruiker en genereer de API Key door op 'Genereer' te klikken.
Let op! Kopieer deze volledig met ctrl + A; - Klik op de groene knop Wijzig. (alleen van toepassing voor API 4.0).
Let op!
- Geef nooit een Default Administratiecode op bij de API-gebruiker. Wanneer je dit wel doet is de API-koppeling beperkt tot deze online administratie. Er kan in dat geval alleen informatie opgevraagd worden uit deze specifieke administratie.
- Via de meewerkfunctie kan er geen API-Key gegenereerd worden. Dit kan gedaan worden door de systeembeheerder die de CASH licentie beheert. Deze kan jou vervolgens voorzien van de API-key.
Mocht de API ontwikkelaar ook zelf in CASHWeb willen kijken, dan moet hier nog een gebruiker voor worden aangemaakt.