Webservice en dataservice
Easyflex richt zich op de professionele aanbieders van flexibele arbeid en biedt applicatiediensten aan via het ASP (Application Service Provider) model. Easyflex levert een totaaloplossing waarmee klanten de meest belangrijkste bedrijfsprocessen in een eenvoudige omgeving kunnen uitvoeren. Voor ontsluiting van de informatie welke is opgeslagen in de centrale database heeft Easyflex dataservices ontwikkeld. Met de door Easyflex ontwikkelde dataservice-operaties kunnen gegevens in de Easyflex database worden geraadpleegd en bewerkt. De Easyflex dataservices zijn gebaseerd op het standaard SOAP protocol.
Dit document beschrijft de werking en de aansturing van de Easyflex API's en is gericht op ontwikkelaars die via SOAP een applicatie of website wensen te koppelen aan Easyflex. Bij dit document horen een aantal voorbeeldbestanden in XML formaat, een WSDL bestand en een voorbeeld key. De termen “relatie” en “inlener” worden in dit document door elkaar gebruikt maar hebben dezelfde betekenis.
De beschikbare API's
Easyflex biedt twee koppelvlakken aan, de Webservice en de DataService. De Webservice is gemaakt om online portalen mee te kunnen ontwikkelen. Online portalen waar een flexwerker of een relatie op in moet loggen en zijn uren kan inzien en doorgeven. Daarnaast zijn er algemene operaties om gegevens op te halen om bijvoorbeeld urenbestanden te verwerken.
De Dataservice API is meer geschikt voor het maken van live koppelingen tussen andere systemen en Easyflex. Het is een breed koppelvlak wat gebruikt kan worden om bijvoorbeeld een front-office pakket te maken waarin flexwerker- en relatie gegevens kunnen worden bewerkt. Maar ook om uren en management informatie op te halen. Omdat het kan gaan om grote hoeveelheden gegevens werken de meeste operaties met de mogelijkheid om kleinere blokken van gegevens op te halen.
Het is mogelijk om operaties van de webservice en de Dataservice API door elkaar te gebruiken omdat ze technisch hetzelfde werken en ook hetzelfde beveiliging mechanisme gebruiken. Alleen de 'endpoints' aan de zijde van Easyflex zijn verschillend. Beide API's maken gebruik van dezelfde 'servicekey' die elke aanroep moet bevatten. En verder moet binnen elke werkmaatschappij van Easyflex de IP adressen bekend zijn van de server(s) die Easyflex aanroepen.
Aanvragen service key
De order voor de testkey kan gedownload worden via het online handboek onder ‘Downloads > Opdrachtbevestigingen’. Omdat de Dataservice ook gebruik maakt van de key van de webservice, kun je het aanvraagformulier voor de testkey van de Webservice gebruiken.
Een definitieve key kun je in Easyflex zelf aanmaken bij ‘Beheer -> Administratie -> Webservice’. In dit scherm kunnen ook de IP-adressen van de servers worden ingevoerd die toegang krijgen tot de werkmaatschappij via de Webservice en/of Dataservice.
SOAP-Guide
Voor ontwikkelaars die willen koppelen met behulp van de Webservice en/of Dataservice is er de SAOP-Guide. De SOAP-Guide is een online tool, ontwikkeld om de koppeling met Easyflex, met behulp van de webservice en/of dataservice, te vergemakkelijken.
De SOAP-Guide voor de productieomgeving vindt u op https://soapguide.easyflex.net.
De SOAP-Guide voor de sandbox vindt u op https://soapguide-sandbox.easyflex.net.
Vragen?
Voor vragen kan gemaild worden naar koppelingen@easyflex.nl . Vermeld in de mail de volgende informatie:
Voor welke Easyflex klant de webservice en/of dataservice aangeroepen wordt
Wat je probeert te realiseren met de service
Welke SOAP-call je hiervoor gebruikt
Hoe de HTTP-body die verstuurd wordt eruit ziet
Welke problemen je hierbij ondervindt
De handleiding bestaat uit de volgende onderdelen: