Introductie
Het onlineplatform AccountView.Net biedt de mogelijkheid om een API voor eigen online-applicaties beschikbaar te stellen. Met een API kunnen AccountView-administraties veilig via internet worden benaderd. U kunt bijvoorbeeld administratiegegevens door middel van een app op een smartphone tonen en bewerken.
De API is een uitbreiding op ons onlineplatform AccountView.Net dat al de brug vormde tussen AccountView Windows en bestaande apps, zoals Visma Scanner en AccountView Contact. Door deze uitbreiding is het ook voor andere partijen eenvoudig om hun apps snel, stabiel en veilig met AccountView te koppelen.
Deze pagina is bedoeld voor externe partijen of AccountView-partners die meer informatie willen over de mogelijkheden en de stappen om te starten met het ontwikkelen van AccountView.Net-apps of het integreren van koppelingen.
Vereisten
Voor het gebruik van de API in AccountView.Net zijn een aantal vereisten. Deze worden hieronder beschreven:
- De klant moet beschikken een recente versie van AccountView.
- De klant moet minimaal beschikken over een AccountView Team- of Business-uitvoering.
- Daarnaast is de module AccountView Online Connector of Communication Service Online nodig in de licentie.
De module AccountView Online Connector is in AccountView een standaard onderdeel van de licentie. De module beschikt enkel over de functionaliteit om gebruik te maken van de Windows COM-techniek voor de communicatie tussen AccountView en de AccountView Communication Service (ACS).
- Daarnaast is het nodig dat de modules aanwezig zijn die worden aangesproken met de API.
- De AccountView Communication Service (ACS) is een Windows-service die zorgt voor de communicatie tussen het AccountView.Net-platform en AccountView Windows. Meer informatie vindt u op onze pagina Visma-diensten activeren.
- Er dient een actieve AccountView.net omgeving te zijn gekoppeld aan het AccountView serienummer. Deze omgeving maakt u aan bij het activeren van de Visma-diensten. Tijdens het doorlopen ervan legt u een beheerder vast van de omgeving die ook in AccountView gekoppeld is aan een gebruiker.
- De tab Ontwikkelaar dient aan te staan voor de gebruiker die in AccountView.net gaat ontwikkelen.
Documentatie web-API op tab Ontwikkelaar
Wilt u zelf een nieuwe app ontwikkelen en zoekt u documentatie? In AccountView.Net is zeer uitgebreide documentatie te vinden voor de ontwikkelaar op de tab Ontwikkelaar.
Deze tab ziet u alleen als deze functionaliteit is aangezet door AccountView Support. Stuur ons een verzoek via ons contactformulier indien u deze nodig hebt.
Deze documentatie helpt een ontwikkelaar bij het aanspreken van AccountView. De documentatie bevat onder andere de 'best practises', voorbeeldscripts, een voorbeeld-app en informatie over het geprogrammeerd inloggen.
Er is daarnaast de beschikking over twee ingebouwde apps in AccountView.Net: de Data Dictionary en de API Builder. Deze apps maken het mogelijk om op zeer gebruiksvriendelijke wijze informatie uit de gekoppelde AccountView-omgeving op te halen en requests samen te stellen.
Bent u een ontwikkelaar van een niet-AccountView-leverancier, dan kunt u bij onze afdeling Verkoop meer informatie opvragen.
Wilt u als klant meer informatie over AccountView.Net-apps en de API, raadpleeg dan uw AccountView-leverancier.
AccountView-databasestructuur
Data dictionary
In de Data Dictionary van AccountView vindt u een overzicht van de tabelstructuur van AccountView.
Kies Document > Stamgegevens programma > Data Dictionary. U krijgt nu een overzicht van alle tabellen.
Kies Zoeken > Velden om de velden van de geselecteerde tabel te bekijken.
In dit venster kunt u met Rapporten > Verplichte velden een overzicht opvragen van alle verplichte velden in deze tabel.
Via Bewerken > Alle Velden weergeven of Bewerken > Alle indexen weergeven kunt u over alle tabellen heen de velden of indexen opvragen.
Meer informatie
In AccountView wordt veel gebruik gemaakt van virtuele tabellen. Virtuele tabellen zijn tabellen die zijn gebaseerd op andere tabellen. In de Data Dictionary kunt u in de stamgegevens van een tabel (Bewerken > Stamgegevens) op het tabblad Overig de basistabel opvragen. Een virtuele tabel bevat altijd velden van zijn basistabel. Het is niet mogelijk om een koppeling naar een virtuele tabel te maken, u moet de koppeling maken naar de basistabel.
Heeft u meer ondersteuning nodig bij het maken van een koppeling, dan adviseren wij om contact op te nemen met uw AccountView leverancier.
Activeren AccountView.net
Om de AccountView.net omgeving aan te maken voor de API in AccountView.Net, moet u de supportnote wizard Visma-diensten activeren doorlopen.
Neem contact op met de leverancier van uw externe applicatie voor informatie over de inrichting en het gebruik van de betreffende app.
Techniek
De API in AccountView.Net biedt de mogelijkheid om een koppeling in te richten op basis van de nieuwste technieken. Via de REST API kunnen de data uit AccountView op een generieke manier worden opgehaald en bewerkt. Daarnaast worden de volgende protocollen gebruikt:
Beveiliging
De AccountView Communication Service initieert zelf de verbinding met AccountView.Net en communiceert via een HTTPS-verbinding.
De API in AccountView.Net houdt voor het raadplegen, bewerken en verwijderen van gegevens in AccountView vast aan de rechten van de betreffende gebruiker in AccountView waardoor een eventuele complexe rechtenstructuur in AccountView niet hoeft te worden aangepast.
Tijdelijke app koppelen aan gebruiker
Op de pagina de wizard Visma-diensten activeren leggen wij uit hoe apps aan gebruikers kunt koppelen.
Wanneer u een app ontwikkelt, zult u de app niet kunnen toevoegen vanuit een lijst apps. U doet dit dan met een API-sleutel.
Sommige apps zijn standaard niet zichtbaar in de lijst met AccountView.net-apps. Voor deze apps hebt u een zogenoemde toegangssleutel nodig die u krijgt van de maker van de app. Als u een beperkt toegankelijke applicatie wilt koppelen aan een gebruiker voert u de volgende stappen uit:
- Ga naar Document > Stamgegevens systeem > Gebruikers.
- Selecteer een gebruiker die de externe applicatie gaat gebruiken.
- Druk op F6 om de stamgegevens van die gebruiker te openen. Dit is niet de VISMANET gebruiker, maar bijvoorbeeld een specifiek aangemaakte gebruiker voor deze app.
- Zorg dat er een bruikbaar e-mailadres is ingevoerd.
- Kies OK.
- Kies Zoeken > AccountView.Net-apps.
- Kies Bewerken > Beperkt toegankelijke app toevoegen.
- Voer in het veld API-sleutel de toegangssleutel in.
- U kunt controleren of de gebruikers correct zijn geregistreerd door Document > Gebruikers registreren in Visma-diensten te kiezen in het venster Gebruikers. In dit rapport ziet u welke gebruikers in AccountView.Net zijn geregistreerd.
- U bent nu klaar om de AccountView de externe app te gaan gebruiken.
