Beschrijving: Essentieel hulpmiddel voor het aanmaken, bekijken en beheren van toegangstokens (API-sleutels) die worden gebruikt om Framework360 te verbinden met externe diensten en applicaties.
Waarvoor is het bedoeld? (Praktische voorbeelden)
Dit hulpmiddel is cruciaal wanneer je Framework360 gecontroleerd en veilig wilt laten communiceren met externe systemen.
- Integratie met software van derden: Gebruik het om een speciale sleutel te genereren waarmee boekhoudsoftware of een data-connector (ETL) alleen toegang krijgt tot de benodigde functies (bijv. het lezen van bestellingen).
- Ontwikkeling van aangepaste mobiele/web-apps: Handig om een token te maken dat een speciaal ontwikkelde mobiele applicatie toestaat specifieke oproepen uit te voeren (bijv. registratie van een nieuwe gebruiker) binnen het systeem.
- Toegangscontrole: Hiermee kun je precies beperken welke handelingen (bijv. wijzigen, aanmaken, lezen) door elke integratie mogen worden uitgevoerd, wat de veiligheid van het systeem verhoogt.
Belangrijkste functionaliteiten
1. Sleutelbeheer
- Eenvoudig aanmaken: Je kunt met één klik een nieuwe API-sleutel genereren door een beschrijvende naam op te geven. Het systeem genereert automatisch een unieke token van 40 tekens.
- Monitoring: De hoofdlijst toont de laatste gebruiksdatum van elke sleutel, zodat je snel inactieve of vaak gebruikte sleutels kunt identificeren.
- Verwijderen: Hiermee kun je direct de toegang intrekken door de sleutel te verwijderen.
2. Configuratie van machtigingen (granulariteit)
Het belangrijkste aspect is de mogelijkheid om nauwkeurig te bepalen wat elke sleutel mag doen.
- Definitie van functies: Via tabbladen en selectievakjes kan de gebruiker aangeven welke specifieke API-functies (bijv.
creacliente,eliminaprodotto,leggi_campagna) zijn toegestaan voor die token. - Meervoudige selectie: Er is een knop "Alles selecteren" beschikbaar om snel alle functies toe te staan.
Hoe stel je het in
Bij het bewerken van een API-sleutel kom je in het configuratiescherm dat is verdeeld in twee hoofddelen: Algemene instellingen en Machtigingen.
Algemene instellingen
| Optie | Beschrijving |
|---|---|
| Api Key | De unieke token die door het systeem is gegenereerd. Moet aan de externe applicatie worden verstrekt. |
| Aanmaakdatum | Datum waarop de sleutel is aangemaakt. |
| Vraag gebruikersauthenticatie aan | Als deze optie actief is, is de API-sleutel niet voldoende op zichzelf. Elke API-aanroep moet ook een geldige gebruikerssessietoken bevatten (via de header X-Fw360-UserToken). |
Beheer machtigingen per rol
Het machtigingsbeheersysteem is georganiseerd per gebruikersrol. Dit maakt het mogelijk verschillende sets machtigingen te definiëren afhankelijk van de context waarin de sleutel wordt gebruikt.
1. Navigatie via tabbladen: De tabbladen (of "stappen") in het gedeelte Machtigingen komen overeen met de verschillende gebruikersrollen die in het systeem zijn geconfigureerd (bijv. Administrator, Klant, Agent).
2. Toewijzing van functies: Binnen elk tabblad kunnen API-functies worden geselecteerd om toe te staan.
3. Beperking per rol: Voor rollen anders dan Administrator waarschuwt het systeem dat oproepen met die sleutel ook rekening houden met toegangsbeperkingen die al voor die rol zijn ingesteld in de module Rolbeheer.
4. Extra beveiliging (slotpictogram): Naast sommige API-functies kan een slotpictogram verschijnen. Indien geselecteerd betekent dit dat juist die functie, zelfs als deze door de API-sleutel is ingeschakeld, verplicht vereist dat de oproep vergezeld gaat van geldige gebruikersauthenticatie (zelfs als de algemene optie "Vraag gebruikersauthenticatie aan" niet actief is).
Automatische integraties
Deze module is het toegangspunt voor alle externe integraties. De configuratie ervan beïnvloedt direct hoe externe systemen kunnen interageren met gegevens en functionaliteiten van Framework360.
Gebruikers toegangscontrole: Wanneer je de optie "Vraag gebruikersauthenticatie aan" activeert, authenticeren API-sleutels niet alleen de applicatie, maar koppelen ze ook de oproep aan specifieke rechten van de gebruiker die de externe applicatie gebruikt. Dit garandeert bijvoorbeeld dat een klant alleen zijn eigen gegevens kan lezen, zelfs als de API-sleutel algemeen toegang verleent.
