|
Mogelijkheden |
De Formdesk webservice kent net als iedere webservice een aantal functies (ook vaak methods genoemd). De functie FormsGet bijvoorbeeld geeft een lijst met alle formulieren in uw account. De programmeur die uw connector maakt kan door het combineren van functies een bepaalde toepassing maken.
Dit document heeft tot doel u een beeld te geven van de mogelijke toepassingen die u met gebruik making van de webservice kunt realiseren. Het is echter geen uitputtende lijst. Heeft u een bepaalde toepassing voor ogen en wilt u weten of de webservice daar een rol in kan vervullen, neemt u dan gerust contact op met één van onze specialisten. We hebben consultants beschikbaar die u in het traject kunnen begeleiden of zelfs de rol van projectleider op zich kunnen nemen. |
|
|
|
Kosten en uitproberen |
Voor het gebruik van de webservice kunt u API-credits kopen. Voor bijna alle functies geldt dat ze bij gebruik 1 credit kosten. Sommige functies kosten geen credits en andere functies kosten credits naar gelang de hoeveelheid informatie die de functie teruggeeft. De technische handleiding vermeldt bij iedere functie hoeveel credits deze verbruikt.
Iedere functie geeft terug hoeveel API-credits er nog over zijn. De connector kan daarmee controleren of het saldo aan credits nog voldoende is. Daarnaast wordt u, net als bij het bereiken van de abonnementslimieten, per e-mail gewaarschuwd als de API-credits bijna op zijn.
Heeft u een standaard abonnement en de API-credits zijn verbruikt dan kunt u de webservice niet meer gebruiken. Bij een zakelijke abonnement blijft de webservice wel functioneren.
Om de webservice te kunnen uitproberen krijgt u 100 API-credits.
API-credits kosten 50 euro per 5.000 credits. Probeert u uw applicatie dan ook zo efficient mogelijk te programmeren zonder onnodige api aanroepingen. |
|
|
|
Beveiliging |
|
De communicatie van gegevens kan over een beveiligde verbinding plaats vinden (SSL). Ook de connector moet, net als u, inloggen in Formdesk. Dit gaat niet met uw gebruikersnaam en wachtwoord maar met een speciale sleutel, de api-key. Deze sleutel vindt u op de pagina ‘account-gegevens’ in uw Formdesk supervisor account. De connector logt in met ‘administrator’-rechten, dezelfde rechten die de supervisor van het account heeft. |
|
|
|
Vooraf automatisch invullen van bekende gegevens |
Met de functie Park kunnen gegevens die automatisch op een formulier moeten worden ingevuld tijdelijk bij Formdesk worden ‘geparkeerd’. Formdesk geeft daarop een complex en uniek ticketnummer terug. Wordt het formulier gestart met dit nummer als parameter dan vult Formdesk de bijbehorende gegevens op het formulier in.
Case 1
Een organisatie heeft diverse Formdesk formulieren voor intern gebruik zoals verlofaanvragen, declaraties, het aanvragen van een nieuwe pc, telefoon, toegangspas etc. De linkjes naar deze formulieren staan op het intranet. Persoonsgegevens van de medewerker zijn vastgelegd in bijvoorbeeld Microsoft Active Directory. Het is wenselijk dat deze gegevens al op een formulier zijn ingevuld als een medewerker het formulier opent.
De medewerker is ingelogd in het intranet en is bij ‘het systeem’ bekend op het moment dat hij een formulier start. De organisatie heeft om dit te bewerkstelligen een connector laten ontwikkelen. De link op het intranet verwijst niet direct naar het formulier maar naar deze connector. De connector haalt uit Active Directory de persoonsgegevens die nodig zijn voor het betreffende formulier en parkeert deze bij Formdesk. De connector ontvangt daarop een ticketnummer van Formdesk en start vervolgens het formulier met dit nummer. Formdesk vult de bijbehorende gegevens alvast in het formulier in.
Case 2
Een gemeente biedt via haar website verschillende formulieren aan haar inwoners aan. Het is wenselijk dat een inwoner zich eerst identificeert met behulp van zijn DigiD login waarna de gegevens van deze inwoner die in de Gemeentelijke Basis Administratie (GBA) staan, zijn ingevuld op het formulier.
De gemeente heeft een connector laten ontwikkelen. De link op de website verwijst niet direct naar het formulier maar naar deze connector. De connector routeert de inwoner naar DigiD en haalt als het inloggen slaagt, de persoonsgegevens van de inwoner uit de GBA op en parkeert deze bij Formdesk. De connector ontvangt daarop een ticketnummer van Formdesk en start vervolgens het formulier met dit nummer. Formdesk vult de bijbehorende gegevens alvast in het formulier in. |
|
|
|
Automatisch inloggen |
Met de functie SignOn kunt u gebruikers die zijn ingelogd in uw systeem (netwerk, intranet etc) automatisch inloggen in Formdesk en zo een zogenaamde ‘Single SignOn’ creëren. Dit geldt voor zowel Formdesk account gebruikers als Formdesk formulier bezoekers (indien u een formulier heeft waarbij u de instelling Bezoeker moet eigen invoer kunnen onderhouden heeft aangevinkt). De gebruiker moet bekend zijn binnen uw Formdesk account. Uw systeem hoeft niet noodzakelijkerwijs de Formdesk inloggegevens te weten. Een uniek gegeven zoals de naam of e-mail adres is voldoende.
Case
Een organisatie heeft diverse Formdesk formulieren voor intern gebruik zoals verlofaanvragen, declaraties, het aanvragen van een nieuwe pc, telefoon, toegangspas etc. De linkjes naar deze formulieren staan op het intranet. Het is wenselijk dat een medewerker overzicht heeft over eerdere aanvragen maar niet telkens in hoeft te loggen.
De medewerker is ingelogd in het intranet en is bij ‘het systeem’ al bekend op het moment dat hij een formulier start. De organisatie heeft een connector laten ontwikkelen. De link op het intranet verwijst niet direct naar het formulier maar naar deze connector. De applicatie logt de gebruiker in met gebruikmaking van het e-mail adres van de gebruiker en start vervolgens het formulier.
Tip: De API kent ook een aantal functies om formulier bezoekers te beheren waaronder het aanmaken van nieuwe bezoekers. Hierdoor kunt u het hele proces van beheren van gebruikers in Formdesk overlaten aan uw systeem.
Tip: Het is naast het automatisch inloggen vaak ook wenselijk dat reeds bij uw systeem bekende gegevens al in het formulier zijn ingevuld. Hiervoor kunt u de functie Park gebruiken. |
|
|
|
Ingevulde gegevens uitwisselen |
Naast het handmatig downloaden van ingevulde formulieren via uw Formdesk account kunt u ook met gebruikmaking van de webservice ingevulde gegevens uitwisselen. Bijvoorbeeld om ingevulde formulieren automatisch in te lezen in uw boekhouding, orderverwerkingsysteem etc. De connector die u hiervoor laat maken kan regelmatig, bijvoorbeeld eens per dag nieuw ingevulde- en gewijzigde formulieren downloaden en verwerken. Voordelen van het gebruik van de webservice zijn:
• Volledig automatische verwerking van gegevens mogelijk;
• Formdesk houdt bij welk ingevuld formulier wel en welke nog niet is uitgewisseld. Als een ingevuld formulier wijzigt, wordt deze opnieuw voor de download aangeboden;
• Het gebruik van filters is mogelijk;
• Eventueel met een ingevuld formulier meegezonden bestanden kunnen worden gedownload;
• Het ingevulde formulier kan als PDF worden gedownload;
• Na uitwisseling kunnen de ingevulde formulieren desgewenst worden verwijderd.
|
|
|
|
Muteren van ingevulde formulieren |
De webservice kent functies om ingevulde formulieren toe te voegen, te wijzigen en te verwijderen. Bij het toevoegen en het wijzigen heeft u de keuze of de processen die normaal na het invullen van een formulier worden uitgevoerd zoals het verzenden van de email-berichten, nu moeten worden uitgevoerd.
Case
U heeft een Formdesk formulier waarbij een deel van de workflow in uw eigen systeem wordt afgehandeld. Het is niet alleen wenselijk dat een ingevuld formulier automatisch in het eigen systeem wordt ingelezen maar ook dat na bepaalde handelingen in het eigen systeem het ingevulde formulier wordt geupdate en de workflow wordt voortgezet.
Bij de paragraaf ‘ingevulde gegevens uitwisselen leest u hoe de ingevulde gegevens in uw eigen systeem kunnen worden ingelezen. Uw eigen systeem roept nadat een gebruiker bepaalde handelingen heeft verricht de connector aan die u hiervoor heeft laten maken. Deze connector update (wijzigt) het ingevulde formulier in Formdesk waarna Formdesk het volgende workflow bericht verzendt.
Case
U wilt nadat u een order heeft uitgeleverd aan een klant, de klant uitnodigen een tevredenheids-enquête in te vullen.
Uw logistieke systeem start automatisch nadat een order is uitgeleverd een connector die u heeft laten maken. Deze connector voegt een formulier toe met relevante gegevens van de klant waaronder de naam en het email-adres. Formdesk verzendt hierna per e-mail de uitnodiging met daarin de link om het formulier te starten. |
|
|
|
Muteren van formulier bezoekers |
|
Indien u een formulier heeft waarbij u de instelling Bezoeker moet eigen invoer kunnen onderhouden heeft aangevinkt dan moeten bezoekers zich registreren alvorens ze het formulier kunnen invullen. De webservice kent functies om automatisch registraties toe te voegen, te wijzigen of te verwijderen. In combinatie met de functie SignOn kan zo bijvoorbeeld een Single SignOn worden gecreëerd. |
|
|
|
|
|
|