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


Ignore:
Timestamp:
Aug 18, 2022 10:32:45 AM (4 years ago)
Author:
henk
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentatie/Beheerder/HowTos/ApiDocumentatie

    v6 v7  
    55 
    66= API-documentatie = 
    7 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's kunnen via deze pagina ook gelijk worden getest. 
    8  
    9 Voor de meeste API's moet eerst worden ingelogd. Gebruik hiervoor de login-api. Hieronder volgt een beschrijving, maar raadpleeg voor de API die voor u geldt altijd de API-documentatie van OpenAC 3 zelf, onder de kop "Login" 
     7OpenAC 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. 
    108 
    119== Authenticatie == 
    12 === JWT token === 
     10Voor de meeste API-endpoints is authenticatie vereist. Authenticeren kan op twee manieren: 
     11* Token based; 
     12* Cookie based;  
    1313 
    14 === Login-API met cookie === 
     14=== Token based (JWT-token) === 
     15Bij 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.  
     16 
     17==== Aanbevelingen ACL-inrichting ==== 
     18 
     19 
     20=== Cookie based (Login-API) === 
    1521Met de login-API kan een sessie worden opgebouwd met de OpenAC 3 server. 
    1622De API kan zowel met als zonder Two Factor Authentication gebruikt worden.