Inleiding
Om koppelingen te kunnen maken met derde partijen, zoals webshops, online rapportage oplossingen en andere pakketten die informatie naar CASH willen wegschrijven en/of willen kunnen uitlezen, biedt CASH de CASH API 3.0 koppeling.
Deze koppeling is in eerste instantie bedoeld voor CASHWeb, maar CASH biedt ook de mogelijkheid om offline administraties in CASHWin beschikbaar te maken voor de CASH API 3.0 koppeling.
Dit document beschrijft hoe offline administraties in CASHWin beschikbaar gemaakt worden voor de CASH API 3.0 koppeling.
API gebruiker op CASHWeb aanmaken
Als eerste maak je op CASHWeb een aparte gebruiker aan voor de API koppeling, log hiervoor in op CASHWeb en ga naar het Gebruikers overzicht. Klik in het overzicht op
Maak aan om een nieuwe CASHWeb gebruiker aan te maken:
- Login (e-mail): een eigen e-mail adres op waar de foutmeldingen met betrekking tot de API koppeling naar verstuurd moeten worden
Naam: API
De overige instellingen voor de API gebruiker laat je leeg, ze zijn niet van belang voor de API koppeling en als er op CASHWeb met deze gebruiker ingelogd wordt, heeft deze gebruiker geen rechten op het CASHWeb portaal.
Default Administratiecode API gebruiker
Geef op CASHWeb nooit een Default Administratiecode op bij de API gebruiker, anders is de API koppeling beperkt tot deze online administratie: Er kan in dat geval alleen informatie opgevraagd worden uit deze ONLINE administratie.
CASHWin
Om de koppeling met API via CASHWin tot stand te brengen, moeten er een aantal zaken ingericht worden:
- Er moet een aparte gebruikerscode aangemaakt worden voor de API koppeling
- Deze gebruiker is beperkt tot het verwerken van API-instructies
- De gebruikerscode SETUP moet correct ingesteld staan
- In de CASH Setup moet Synchronisatie offline worden ingesteld
- Er moet een apart CASHWin proces draaien voor gebruikerscode API op de server
- TLS 1.2 activeren in Internet Explorer
Gebruikerscode API voor CASHWin aanmaken
- Start CASHWin op met gebruikerscode SETUP
- Ga naar Onderhoud > Gebruikersprofielen
- Maak een nieuwe gebruikerscode aan: API
- Vul de volgende gegevens in:
administratiecode: DEMO*
Toepassing: CASH
Startfunctie: S0067 (de functie Inlezen berichten)
API 2.0
Gebruikers van Cash Webservices / CASH API 2.0 stellen hier functie S0066 in. Voor het gebruik van functie S0067, en voor het gebruik van CASH API 3.0, is een licentie voor de module CASH Connect nodig.
Onder het kopje ‘Koppeling CASH Webservices’ geef je de inloggegevens op die u voor de API gebruiker op CASHWeb hebt aangemaakt:
Administratiecode DEMO
Om de API koppeling te laten functioneren, moet er in CASHWin een administratie geopend worden door de gebruiker API. Gebruik hiervoor geen eigen administratie omdat deze administratie altijd open blijft staan, er worden voor geopende administraties geen back-ups gemaakt, wij adviseren hierom om bij gebruiker API de DEMO administratie in te stellen.
Heb je geen DEMO administratie? Maak in CASHWin een nieuwe lege administratie aan en koppel deze administratie aan gebruiker API.
Gebruikerscode SETUP
Ook bij gebruikerscode SETUP moeten de inloggegevens voor de API gebruiker worden ingesteld om de API koppeling te laten werken.
- Ga naar Onderhoud > Gebruikersprofielen
- Selecteer gebruikerscode: SETUP
- Onder het kopje ‘Koppeling CASH Webservices’ geef je opnieuw de inloggegevens op voor de API gebruiker die op CASHWeb is aangemaakt.
Synchronisatie offline
Ga naar Onderhoud > Synchronisatie offline en bepaal welke CASHWin administraties beschikbaar moet zijn voor de API koppeling:
Hierna ga je naar Onderhoud > Instellen CashWeb API, hier geef je aan welke records er voor de API koppeling beschikbaar zijn: Vink hiervoor de juiste optie aan of geeft de specifieke records op die voor de API koppeling beschikbaar moeten zijn, zoals relaties (0101) en grootboekmutaties (0301):
Druk in dit formulier op de help-icoon in de knoppenbalk voor meer uitleg.
Let op! De optie ‘Alle gegevens’ betekent dat alle gegevens in de administratie beschikbaar zijn voor de API koppeling.
Een apart CASHWin proces voor gebruikerscode API
Om de verbinding met CASH API 3.0 tot stand te brengen moet in CASHWin de API koppeling gestart worden, dit kan vanaf de Windows opdrachtprompt vanuit de installatiemap van CASHWin met het commando: cashwin.exe API
- CASHWin normaal opstarten en gebruikerscode API selecteren kan ook:
CASHWin start vervolgens op, je ziet dit omdat na enkele seconden de functie Inlezen berichten geopend wordt:
Zolang de functie Inlezen berichten (S0067) actief is, wordt er elke 30 seconde op CASHWeb gekeken of er een API-instructie is om uit te voeren. Dit proces blijft draaien totdat je deze functie annuleert.
Tip! Je kunt de opdracht ‘cashwin.exe API’ toevoegen aan de programma’s die automatisch opstarten met de server, dit kan bijvoorbeeld via de Windows Taakplanner. Let er op dat deze opdracht op de server vanuit de installatiemap van CASHWin uitgevoerd moet worden.
Webshop
Voor een webshop moet de functie Inlezen berichten (S0067) altijd actief zijn omdat een webshop zeer regelmatig gegevens met de administratie uitwisselt.
Het TLS 1.2 protocol activeren in Internet Explorer
Voor de communicatie tussen CASHWin en CASHWeb moet het TLS 1.2 protocol geactiveerd zijn in Internet Explorer.
Op de volgende wijze activeer jr het TLS 1.2 protocol:
- Start Internet Explorer op
- Druk op de toetsencombinatie: Alt + X, het submenu “Extra” wordt geopend
- Selecteer de optie: Internetopties (Internet Options)
- Ga naar het tabblad Geavanceerd (Advanced)
- Controleer dat het TLS 1.2 protocol is aangevinkt:
- Klik op OK om de wijzigingen te bevestigen en sluit Internet Explorer weer af
De API koppeling instellen bij een derde partij
Om de API koppeling met CASHWin te maken zal een derde partij vanuit hun applicatie de mogelijkheid moeten bieden om in te loggen op CASHWeb, hier gebruik je de inloggegevens van de aparte gebruiker die je eerder op CASHWeb heeft aangemaakt voor de API koppeling:
- De administraties en beschikbare records die voor deze derde partij beschikbaar zijn heb je in de SETUP van CASHWin opgegeven in ‘Synchronisatie offline’ zoals staat uitgelegd in paragraaf Synchronisatie offline.