API-documentatie raadplegen

De online documentatie van de LIVEEVENTS Public API bevat gedetailleerde informatie over welke endpoints en velden beschikbaar zijn.

De documentatie is een interactieve, altijd actuele weergave van de API. Je vindt er per endpoint de URL, de verwachte parameters, het antwoord en voorbeelden van requests. Werk je samen met een ontwikkelaar van een integratiepartner, dan is dit het document waar jullie samen naar verwijzen.

De API zelf is een RESTful HTTP-API beschreven volgens de OpenAPI 3.1-standaard. Dat betekent dat je ontwikkelaar de specificatie ook kan importeren in tooling zoals Postman of een eigen codegenerator. De documentatie online wordt rechtstreeks uit diezelfde specificatie opgebouwd, dus wat je daar leest, klopt altijd met wat de API werkelijk doet.

Zo open je de documentatie:

1. Ga naar https://events.liveop.cloud/docs.
2. Blader links door de groepen endpoints (bijvoorbeeld evenementen, adviezen, bijlagen, instellingen).
3. Klik op een endpoint om de details rechts te zien.
4. Gebruik de voorbeeld-requests rechts om snel te zien hoe een aanroep eruit hoort te zien.

Je kunt de pagina ook openen vanuit LIVEEVENTS zelf. Open links in het menu Instellingen, kies API, en klik onder Documentatie op Open API documentatie →. Je komt dan op dezelfde pagina uit.

De OpenAPI-specificatie zelf gebruiken

Werk je met tooling die OpenAPI-bestanden kan inlezen? De ruwe specificatie is bereikbaar vanaf dezelfde basis-URL. Je ontwikkelaar kan deze importeren om automatisch een client te genereren of de aanroepen in een testtool te zetten. Verwijs hen door naar de documentatiepagina; daar staat de actuele link naar het JSON- of YAML-bestand.

Wat als de pagina niet laadt

Een blanco of foutpagina betekent meestal dat je geen netwerktoegang hebt tot events.liveop.cloud, of dat een proxy het verkeer blokkeert. Probeer de URL in een browser zonder bedrijfsproxy. Lukt het dan nog niet, neem contact op met je IT-beheerder zodat zij de toegang kunnen vrijgeven.