Documentatie

Script Wizard: Interne API

Staat de website waarvan je facturen wilt ophalen er nog niet tussen? Met de Script Wizard maak je zelf een script voor vrijwel elke website — zonder dat je hoeft te programmeren. De wizard begeleidt je stap voor stap door het proces en genereert automatisch een werkend script.

 

Onderstaand een voorbeeld van de script wizard die wordt gebruikt met de Interne API Modus.

#

Je vindt de Script Wizard via het menu Bibliotheek → Nieuw Script Maken (knop in rechterbovenhoek).

Er zijn drie methoden beschikbaar om website scripts te genereren via de script wizard:

    1. Browser Modus – Navigeert door de website zoals een gebruiker
    2. Interne API – Gebruikt de verborgen API van de website (via de browsermodus)
    3. Publieke API – Gebruikt een publieke en gedocumenteerde REST API

 

–> Op deze pagina behandelen we de Interne API modus

Zodra de script wizard is geopend heb je de optie om te kiezen tussen “Website inhoud” en “API”.
Selecteer “Website inhoud” om verder te gaan met de browser modus, vanuit deze modus krijg je later toegang tot de “Interne API” modus.

Stap 1: Scriptnaam en instellingen #

Vul een herkenbare naam in voor het script, zoals de naam van de website. Kies daarna de juiste instellingen:

  • Scriptcategorie: kies “Website” voor een gewoon script, of “Factuurportaal” als het om een herbruikbaar portaalscript gaat (zoals een Stripe Billing Portal die door meerdere scripts gebruikt kan worden).
  • Scriptnaam: plaats hier de naam van het script, dit is meestal gelijk aan de naam van de website. Heeft een website meerdere versies? Zoals bijvoorbeeld een portaal voor particulieren en zakelijke gebruikers? Dan is het handig om dit ook duidelijk te vermelden in de scriptnaam.
  • Inlog URL: de link die wordt gebruikt om in te kunnen loggen op de website. Deze url zal de wizard ook eerst openen om te starten met het configureren van het script.
  • Inlogmethode: geef aan hoe je op deze website kunt inloggen, bijvoorbeeld met wachtwoord of authenticator etc.
  • Factuurpagina URL: de url waar de facturen op staan. Invullen van de link in deze stap is optioneel en kan altijd later in een verdere stap geconfigureerd worden.

 

Klik vervolgens op de knop “Browser Openen” om naar de volgende stap te gaan.
Er opent dan een wizard-omgeving waarbij de inlogpagina van de betreffende site wordt geladen aan de rechterkant. Aan de linkerkant van de wizard zie je een zijbalk. Aan de bovenkant van de zijbalk tref je de instellingen van het nieuw te maken script en opties om het script aan te passen naar wens.

 

Stap 2: Login-elementen selecteren #

–>> Voer het loginproces uit zoals uitgelegd op de browser modus documentatiepagina.

 

Stap 3: Factuurpagina instellen #

Log handmatig in via de ingebouwde browser en navigeer naar de pagina waar je facturen worden getoond. Zodra je op de juiste pagina bent, klik je op Huidige URL Gebruiken.

Stap 4: Factuur downloaden om interne API volledig te detecteren #

Zodra je tijdens de Browser Wizard door de website navigeert, analyseert VerzamelSysteem automatisch het netwerkverkeer van de website. Als er een interne API wordt gevonden die factuurdata aanlevert, verschijnt er een melding:

Interne API Gedetecteerd!

–>> Het beste is om op dit punt nog NIET op “Gebruik interne API” te klikken.
Om alle interne API connecties door VerzamelSysteem volledig te laten detecteren, is het raadzaam om eerst daadwerkelijk een factuur aan te klikken en deze te downloaden in de script wizard. 

 

Stap 5: Interne API gebruiken #

Klik op Gebruik Interne API om over te schakelen naar de interne API-modus.

 

Veld mapping configureren #

Als je voor de Interne API kiest, worden de gevonden velden automatisch gekoppeld aan de factuurdata: factuur ID, datum, beschrijving en download URL. Controleer de automatisch ingevulde mapping en pas deze indien nodig aan. Klik vervolgens op Doorgaan.

 

Browser Fallback (optioneel) #

Je kunt ook een browser-gebaseerde fallback configureren: als de interne API download om wat voor reden dan ook mislukt, schakelt het script automatisch over op de browser-methode. Dit maakt het script extra robuust. Wanneer je deze optie klikt kom je weer terecht in de browser modus, en kun je dat proces afmaken om het script af te ronden.

Klik op Overslaan (Alleen API) als je dit niet wilt instellen.

 

 

Stap 6: Script genereren #

Bij het afronden van het script zie je een samenvatting van alle geselecteerde elementen. Controleer of alles klopt en klik daarna op Script Genereren. VerzamelSysteem maakt automatisch een werkend script en slaat het op in je scriptbibliotheek.

 

 


 

Script bewerken #

Je kunt een bestaand eigen script altijd aanpassen. Open de Scriptbibliotheek, zoek het script op en klik op Bewerken (het potlood icoontje).
De wizard opent opnieuw met je eerder ingevulde instellingen, deze kun je vervolgens aanpassen naar wens.

Na het opslaan word je gevraagd of je het versienummer wilt verhogen — handig als je een bijgewerkte versie wilt delen via de community.

 


 

Script delen via de community #

Heb je een script gemaakt voor een website die anderen ook gebruiken? Deel het dan via de community. Na een check door ontwikkelaars van VerzamelSysteem kunnen andere gebruikers het script vervolgens direct installeren vanuit de Scriptbibliotheek.

–> Klik hier voor meer informatie over het delen van scripts met de community