SpiderFlow documentatie

Documentatie voor microtasks, workflows, projecten en API-runtime.

Deze documentatie beschrijft hoe SpiderFlow is opgebouwd, hoe je automation-assets beheert en hoe je support, debugging en integratie via de lokale runtime aanpakt.

Start met SpiderFlow

Terug naar SpiderFlow

Wat SpiderFlow oplost

SpiderFlow brengt losse browseracties samen in een beheersbaar model. Teams bouwen kleine uitvoerbare bouwstenen, combineren die tot workflows, bundelen workflows in projecten en kunnen dezelfde logica daarna handmatig debuggen of via een lokale API-runtime aanroepen.

No-code / low-code

Configureren in plaats van herschrijven

MicroTasks, Workflows, Projects en Addons maken automation-assets herbruikbaar en aanpasbaar per klant, omgeving of run.

Integratie

API-contract bovenop automatisering

Endpointconfiguraties mappen inkomende payloads naar microtaskopties en geven gecontroleerde output terug.

Operations

Debugbaar en beheersbaar

Debugger, logconsole, data directory, statuschecks en runtime-instellingen maken support en incidentanalyse sneller.

Kernconcepten

MicroTasks

MicroTasks zijn de kleinste uitvoerbare bouwstenen. Ze combineren targetselectie, optionele inputwaarden, validatie en een stapsgewijze actieflow.

Options voor configureerbare input
Target Provider via vaste URL of bestand
Target Validator om targets toe te laten of te skippen
Steps zoals wachten, klikken, extractie, statements, file-output en variabelen

Workflows

Workflows orkestreren meerdere microtasks en addons. Ze vormen de herbruikbare laag tussen losse browseracties en volledige projecten.

Microtasks met prioriteit en option values
Workflow-level options en variables
Addons op workflowniveau
Debugger voor workflowruns

Projects

Projecten zijn de hoogste executielaag. Ze bundelen workflows, directe microtasks, projectvariabelen en projectbrede addons in een uitvoerbaar scenario.

Workflowvolgorde met prioriteit
Active-vlag per workflow
Projectspecifieke option overrides
Projectbrede variabelen en addons

Addons en API Endpoints

Addons zijn herbruikbare stapblokken. API Endpoints vertalen interne automation-assets naar een consumeerbare integratielaag.

preTask- of preStep-logica
Conditionele uitvoering
Input mappings naar microtaskopties
Output mappings vanuit runtimevariabelen

Alle hoofdschermen

De sidebar bevat Dashboard, Projects, Workflows, MicroTasks, Addons, API, Settings en Help. De meeste beheerschermen volgen hetzelfde patroon: lijstweergave, editor, Form/JSON-wissel, save-acties en statusfeedback.

Scherm	Doel	Belangrijkste acties
Dashboard	Runtime-healthcheck voor de lokale API-server.	Status, request, runtime URL, laatste foutmelding en start/stop controleren.
Projects	Hoogste laag voor complete automatiseringsscenario’s.	Workflows combineren, directe microtasks opnemen en projectruns debuggen.
Workflows	Orkestratielaag voor microtasks, addons en variabelen.	Prioriteiten zetten, options invullen en workflowruns testen.
MicroTasks	Kernproduct voor configureerbare browseracties.	Options, target provider, validator, steps en debugger configureren.
API	Endpointconfiguraties en runtime-instellingen.	Routes, mappings, active-status, port, secret key en timeout beheren.

Getting started

Stap 1

Start de UI

Start de Electron app, wacht tot de loader klaar is en controleer of de tabbladen zichtbaar zijn.

Stap 2

Controleer supporttools

Open Help, Log Console en Data Directory om logging en schrijfrechten te controleren.

Stap 3

Maak een MicroTask

Start klein: target, korte wait, eenvoudige click of extract en een duidelijke outputvariabele.

Stap 4

Debug zichtbaar

Zet Show Browser aan, run met minimale input en stop met Stop of Esc als de run niet klopt.

How-to: een MicroTask maken

Basis en options

Ga naar MicroTasks en open New MicroTask.
Vul name, category en description in.
Gebruik options voor alles wat per klant, run of omgeving verschilt.
Praktische types zijn text, spintext en boolean.

Targets, validator en steps

Kies fixed of file als target provider.
Gebruik validators om slechte targets te skippen.
Begin met wait, click of extract textOf.
Debug de microtask los voordat je hem in een workflow zet.

Praktische tips:
- Target pakt niet: controleer interval, uniqueness en targetRegex.
- Stap faalt: isoleer de stap en controleer selector en timeout.
- Variabele blijft leeg: controleer %-naam, selector en extract-output.
- Debug altijd eerst de microtask los.

API endpoints configureren en testen

Het API-scherm maakt van interne automation-assets een stabiele API-laag. Een externe POST-call kan zo landen op een microtask met gecontroleerde input- en outputmapping.

Endpointconfiguratie

Ga naar API en maak een nieuw endpoint.
Vul naam, categorie, beschrijving en route in.
Route moet beginnen met een slash.
Laat active uit tijdens opbouw.

Runtime settings

Vul port, secret key en timeout in.
Klik Save config.
Start API.
Controleer runtime-health in Dashboard.

$headers = @{
  'x-api-key' = 'JOUW_SECRET'
  'Content-Type' = 'application/json'
}
$body = @{ keyword = 'example'; target = 'https://example.com' } | ConvertTo-Json
Invoke-RestMethod -Method Post -Uri 'http://127.0.0.1:7331/jouw/route' -Headers $headers -Body $body

Debugging, backup en troubleshooting

Debugger

Zet Show Browser aan, run met minimale input, lees het resultaatbericht en stop met Stop of Esc als de run niet klopt.

Log Console

Gebruik logs voor stapvolgorde, stepfouten, API/servergedrag en foutmeldingen tijdens runtime.

Data Directory

Controleer executed, failed, rejected, file-step output en api/runtime.config.json voor support en restore.

Symptoom	Waarschijnlijke oorzaak	Actie
Opslaan faalt	Sessie, nonce, netwerk of validatiefout.	Controleer sessie, API-verbinding en formulierfouten.
API runtime start niet	Secret key ontbreekt, port ongeldig of timeout te laag.	Controleer secret key, port en timeout.
API request geeft 401	x-api-key of Bearer-token matcht niet.	Vergelijk exact met API Settings.
Debugrun stopt onverwacht	Step faalt, validator blokkeert target of selector vindt niets.	Bekijk logs, test incrementeel en verifieer target en variabelen.