API-register: Overzicht

Een API om een autorisatiecomponent (AC) te benaderen.

De AUTORISATIE is het kernobject in deze API. Autorisaties worden toegekend aan applicaties. Een applicatie is een representatie van een (web) app die communiceert met de API van (andere) componenten, zoals het ZRC, DRC, ZTC en BRC.

Deze API laat toe om autorisaties van een (taak)applicatie te beheren en uit te lezen.

Afhankelijkheden

Deze API is afhankelijk van:

• Notificaties API

Autorisatie

Deze API vereist autorisatie. Je kan de token-tool gebruiken om JWT-tokens te genereren.

Deze API publiceert notificaties op het kanaal autorisaties.

Main resource

applicatie

Kenmerken

Resources en acties

• applicatie: create, update, destroy

Handige links

• Documentatie
• Zaakgericht werken

Een API om een besluitregistratiecomponent (BRC) te benaderen.

Een BESLUIT wordt veelal schriftelijk vastgelegd maar dit is niet noodzakelijk. Omgekeerd kan het voorkomen dat in een INFORMATIEOBJECT meerdere besluiten vastgelegd zijn. Vandaar de N:M-relatie naar INFORMATIEOBJECT. Een besluit komt voort uit een zaak van de zaakbehandelende organisatie dan wel is een besluit van een andere organisatie dat het onderwerp (object) is van een zaak van de zaakbehandelende organisatie. BESLUIT heeft dan ook een optionele relatie met de ZAAK waarvan het een uitkomst is.

De typering van BESLUITen is in de Catalogi API (ZTC) ondergebracht in de vorm van BESLUITTYPEn.

Afhankelijkheden

Deze API is afhankelijk van:

• Catalogi API
• Notificaties API
• Documenten API (optioneel)
• Zaken API (optioneel)
• Autorisaties API (optioneel)

Autorisatie

Deze API vereist autorisatie. Je kan de token-tool gebruiken om JWT-tokens te genereren.

Deze API publiceert notificaties op het kanaal besluiten.

Main resource

besluit

Kenmerken

• verantwoordelijke_organisatie: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld.
• besluittype: URL-referentie naar het BESLUITTYPE (in de Catalogi API).

Resources en acties

• besluit: create, update, destroy

Handige links

• Documentatie
• Zaakgericht werken

Een API om een notificatierouteringscomponent te benaderen.

Deze API voorziet in drie functionaliteiten voor notificaties:

• registreren van kanalen (=exchanges)
• abonneren van consumers op kanalen
• ontvangen en routeren van berichten

Registreren van kanalen

Een component dekt een bepaald domein af, en heeft het recht om hiervoor een kanaal te registeren waarop eigen notificaties verstuurd worden. Een kanaal is uniek in naam. Een component dient dus te controleren of een kanaal al bestaat voor het registreren. Bij het registeren van kanalen wordt een documentatielink verwacht die beschrijft welke events en kenmerken van toepassing zijn op het kanaal.

Abonneren

Consumers kunnen een abonnement aanmaken voor een of meerdere kanalen. Per kanaal kan op de kenmerken van het kanaal gefilterd worden. Consumers dienen zelf een endpoint te bouwen waarop berichten afgeleverd (kunnen) worden.

Routeren van berichten

Bronnen sturen berichten naar deze API, die vervolgens de berichten onveranderd routeert naar alle abonnees.

Afhankelijkheden

Deze API is afhankelijk van:

• Autorisaties API

Autorisatie

Deze API vereist autorisatie. Je kan de token-tool gebruiken om JWT-tokens te genereren.

Handige links

• Documentatie
• Zaakgericht werken