Changes between Version 7 and Version 8 of Documentatie/Beheerder/HowTos/ApiDocumentatie

Timestamp:

Aug 18, 2022 10:56:55 AM (4 years ago)

Author:

henk

Comment:

--

Documentatie/Beheerder/HowTos/ApiDocumentatie

@@ -5 +5 @@
 
 = API-documentatie =
-OpenAC 3 is volledig API-gebaseerd. Dat betekent dat de gebruikersinterface gebruikt maakt van API's die ook door externe applicaties kan worden geconsumeerd die aan OpenAC willen koppelen. OpenAC maakt gebruik van technologie waarmee API-documentatie automatisch wordt gegenereerd. Deze documentatie is daarom altijd up-to-date voor de versie die u gebruikt. De documentatie is te vinden via menu Beheer -> API-documentatie. Veel API-endpoints kunnen via deze pagina ook gelijk worden getest.
+OpenAC 3 is volledig API-gebaseerd. Dat betekent dat de gebruikersinterface gebruikt maakt van API-endpoints die ook kan worden geconsumeerd door externe applicaties die aan OpenAC koppelen. OpenAC maakt gebruik van een methode waarmee API-documentatie automatisch wordt gegenereerd. Deze documentatie is daarom altijd up-to-date voor de versie die u gebruikt. De documentatie is te vinden via menu Beheer -> API-documentatie. Veel API-endpoints kunnen via deze pagina ook gelijk worden getest.
 
 == Authenticatie ==
@@ -15 +15 @@
 Bij token based authenticatie genereert de OpenAC beheerder een JWT-token en verstrekt deze aan de partij die de OpenAC-API wil gebruiken. Het token heeft een geldigheidsduur. Zolang het token geldig is kan het worden gebruikt om toegang te krijgen tot de OpenAC-API. Omdat het token niet tussentijds kan worden ingetrokken is het belangrijk om de ACL goed in te richten voor het gebruik van de API. 
 
-==== Aanbevelingen ACL-inrichting ====
+==== ACL-inrichting ====
+Als u JWT-tokens verstrekt aan een externe partij dan adviseren we de ACL als volgt in te richten:
+* Maak een gebruikersgroep met de naam van de externe partij voorafgegaan door api- (api-drimpy);
+* Geef deze groep de benodigde rechten in de ACL;
+* Maak één of meerdere gebruikers en maak deze lid van de api-groep;
+* Genereer voor elk van de gebruikers een JWT-token;
 
+Als het nodig is om de externe partij toegang tot de API te ontzeggen dan kunt u de rechten voor de api-groep intrekken in de ACL.
+Als de rechten van één van de api-gebruikers moet worden ingetrokken dan kunt u het api-groep lidmaatschap intrekken.
+
+==== Gebruik token ====
+Roep elk API-endpoint aan met HTTP-header:
+{{{ Authorization: Bearer <token> }}}
 
 === Cookie based (Login-API) ===