API documentatie — LucaFlow

Externe integraties, authenticatie en het triggeren van workflows via de API

Deze pagina geeft een publiek overzicht van de integratieaanpak. Operationele endpointdetails, OpenAPI-specificaties en productiecredentials horen niet op de publieke website thuis en zijn alleen beschikbaar binnen geauthenticeerde klantomgevingen of na afstemming. Zie /prijzen voor de publieke commerciële context.

API-overzicht

De LucaFlow API is een REST API die communicatie via HTTPS ondersteunt. Responses worden geretourneerd als JSON. De API is beschikbaar voor externe systemen die workflows willen triggeren, sessiestatus willen opvragen of data willen uitwisselen.

  • Protocol: HTTPS / REST
  • Formaat: JSON
  • Authenticatie: OAuth 2.0 / API-sleutel (zie hieronder)
  • Beschikbaarheid: afhankelijk van abonnement

Authenticatie

De LucaFlow API gebruikt OAuth 2.0 client credentials voor machine-to-machine communicatie. U heeft een client ID en client secret nodig om een Bearer-token op te halen. Dit token gebruikt u vervolgens in de Authorization-header van API-verzoeken.

API-sleutels en secrets worden nooit opgeslagen in code, configuratiebestanden of publiek toegankelijke locaties. Bewaar uw secrets in een beveiligde opslaagruimte zoals een secrets manager of omgevingsvariabelen.

Voorbeeld authenticatiestap (conceptueel):

POST /auth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=UW_CLIENT_ID
&client_secret=UW_CLIENT_SECRET

Het antwoord bevat een access_token met een beperkte geldigheid. Vernieuw het token voor het verloopt.

Externe integraties

Via de API kunt u LucaFlow koppelen aan externe systemen, zoals:

  • CRM-systemen: klantdata doorgeven aan een workflow
  • ERP-systemen: workflow-output verwerken in uw ERP
  • Chatplatforms: sessies starten vanuit externe chatinterfaces
  • Monitoring-tools: gebruiksstatistieken ophalen

De actuele lijst van beschikbare endpoints en integratiemogelijkheden is beschikbaar voor klanten met API-toegang via het documentatieportaal in het LucaFlow-dashboard. Zo blijft het publieke deel conceptueel en het operationele deel afgeschermd.

Webhooks en import

LucaFlow ondersteunt callbacks naar externe systemen zodra een workflow een bepaalde stap heeft doorlopen of voltooid is. Configureer een webhook-URL in de workflow-instellingen om notificaties te ontvangen.

Import van data (bijv. documenten voor de kennisbank) is beschikbaar via de import-API. Details staan in de documentatie voor klanten met de betreffende abonnementen.

Veiligheid bij API-gebruik

Houd bij het gebruik van de LucaFlow API rekening met de volgende beveiligingsprincipes:

  • Sla client secrets nooit op in frontend-code of publieke repositories
  • Gebruik kortlevende tokens en vernieuw ze tijdig
  • Beperk API-rechten tot het minimaal benodigde
  • Monitor API-gebruik op onverwachte patronen

OpenAPI / Swagger

Een interactieve API-referentie is beschikbaar voor klanten met API-toegang via het LucaFlow-dashboard. De volledige OpenAPI-specificatie is toegankelijk na authenticatie. Publieke pagina's beschrijven de integratieaanpak, maar publiceren geen private credentials, sandboxsecrets of operationele endpointlijsten.

Neem contact op via de contactpagina voor informatie over API-toegang en het aanvragen van credentials.