Skava Skava / Wiki

Aangepaste elementen: API

Een API-interface is een formulier waarvan ingevulde waarden Skava als JSON naar een adres van jouw keuze verzendt (je backend). Op deze manier kun je Skava veilig verbinden met je eigen systemen.

i

Je beheert API-interfaces in de web-app onder Aangepaste elementen → schakelaar API-interfaces. Maken en bewerken is voorbehouden aan bedrijfsadministrators; vrijgegeven interfaces kunnen dan door alle leden van het bedrijf worden geactiveerd.

Een API-interface opzetten

Een interface bestaat uit invoervelden (ze vormen de JSON), het doeladres en authenticatie.

  1. Velden maken: Elk veld krijgt een JSON-sleutel. Rechts zie je live de JSON-voorvertoning, die exact op deze manier naar je backend wordt verzonden.
  2. Adres (URL): het https://-adres van je backend. Alleen HTTPS en openbaar toegankelijke adressen zijn toegestaan (zie Beveiliging hieronder).
  3. Methode: POST (standaard), PUT, PATCH of GET. Met GET worden waarden toegevoegd als queryparameters in plaats van in de body te worden verzonden.
  4. Authenticatie: Stel de headernaam in (bijv. Authorization) en waardeprefix (bijv. Bearer ), sla vervolgens het token op. Stel optioneel een vervaldatum in.
  5. Responsievelden (optioneel): Bepaal per pad welke waarden uit de backend-response moeten worden weergegeven — bijv. order.id of items[0].sku.
  6. Controleer met Ping en Testaanvraag, vervolgens Vrijgeven.

Token veilig opslaan

Het token is versleuteld opgeslagen en wordt nooit aan clients geretourneerd — de app laat alleen zien of een token is ingesteld en wanneer het vervalt. Bij verzending voegt Skava het token serverzijde toe aan de geconfigureerde header. Als je een vervaldatum instelt, weigert Skava de aanroep na verval en vraagt je het token te vernieuwen.

Testen: Ping en testaanvraag

  • Ping — een lichte bereikbaarheidscontrole. Deze controleert alleen of je adres reageert en verzendt geen token of formuliergegevens. Toont bereikbaarheid, status en responstijd. Ideaal als eerste stap.
  • Testaanvraag — de echte proefrit: verzendt voorbeeldgegevens inclusief token naar je adres en toont je het volledige antwoord evenals de geëxtraheerde responsievelden.

Als administrator kun je beide uitvoeren terwijl je nog in het conceptmodus bent om de integratie voor vrijgave te controleren.

Concept en vrijgave

Elke interface begint als concept en kan vrij worden bewerkt. Zodra alles klaar is, geef je het vrij met Vrijgeven.

!

Vrijgegeven interfaces zijn onveranderlijk. Dit is opzettelijk: zodat na vrijgave niemand het doeladres of token stiekem kan verwisselen. Als je iets wilt wijzigen, maak je een nieuwe versie.

Beveiliging

i

Om misbruik van de interface te voorkomen, gelden strikte regels: alleen HTTPS-adressen zijn toegestaan en het adres moet naar een openbare doeladres wijzen — interne adressen (bijv. localhost, privénetwerken of cloud-metadata) worden afgewezen. Skava controleert dit bij elke aanroep, maakt verbinding exact naar het geverifieerde adres, volgt geen redirects en beperkt timeout en antwoordgrootte.

Gerelateerd

Wil je in plaats daarvan een invulbare documentsjabloon bouwen? Zie Aangepaste elementen: documenten.

Veelgestelde vragen

Wat is een API-interface in Skava?

Een formulier waarvan ingevulde waarden Skava als JSON naar een adres van jouw keuze verzendt (je backend) — handig voor het verbinden van Skava met je eigen systemen.

Wie mag API-interfaces maken en activeren?

Maken en bewerken is voorbehouden aan bedrijfsadministrators. Een vrijgegeven interface kan dan door alle leden van het bedrijf worden geactiveerd.

Wat is het verschil tussen "Ping" en "Testaanvraag"?

Ping controleert alleen of het adres bereikbaar is — zonder token en zonder gegevens. Testaanvraag verzendt voorbeeldgegevens inclusief token en toont het volledige antwoord.

Is mijn API-token veilig?

Ja. Het token is versleuteld opgeslagen en wordt nooit aan clients geleverd. De app laat alleen zien of een token is ingesteld en wanneer het vervalt.

Welke adressen zijn toegestaan als eindpunten?

Alleen openbaar toegankelijke https://-adressen. Interne doelen zoals localhost, privénetwerken of cloud-metadata worden afgewezen — dit beschermt tegen misbruik van de interface.

Waarom kan ik een vrijgegeven interface niet meer wijzigen?

Vrijgegeven interfaces zijn opzettelijk onveranderlijk — zodat na vrijgave niemand het doeladres of token kan verwisselen. Voor wijzigingen maak je een nieuwe versie.