Catalogi API
Een API om een zaaktypecatalogus (ZTC) te benaderen.
De zaaktypecatalogus helpt gemeenten om het proces vanuit de 'vraag van een klant' (productaanvraag, melding, aangifte, informatieverzoek e.d.) tot en met het leveren van een passend antwoord daarop in te richten, inclusief de bijbehorende informatievoorziening.
Een CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type, standaardwaarden en processtructuur.
Afhankelijkheden
Deze API is afhankelijk van:
- Gemeentelijke Selectielijst API
- Autorisaties API (optioneel)
Autorisatie
Deze API vereist autorisatie. Je kan de token-tool gebruiken om een token te genereren.
Zelf een token genereren
De tokens die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web
token). In de API calls moeten deze gebruikt worden in de Authorization
header:
Authorization: Bearer <token>
Om een JWT te genereren heb je een client ID en een secret nodig. Het JWT
moet gebouwd worden volgens het HS256 algoritme. De vereiste payload is:
{
"iss": "<client ID>",
"iat": 1572863906,
"client_id": "<client ID>",
"user_id": "<user identifier>",
"user_representation": "<user representation>"
}
Als issuer gebruik je dus je eigen client ID. De iat timestamp is een
UNIX-timestamp die aangeeft op welk moment het token gegenereerd is.
user_id en user_representation zijn nodig voor de audit trails. Het zijn
vrije velden met als enige beperking dat de lengte maximaal de lengte van
de overeenkomstige velden in de audit trail resources is (zie rest API spec).
Notificaties
Deze API publiceert notificaties op het kanaal zaaktypen.
Main resource
zaaktype
Kenmerken
catalogus: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.
Resources en acties
Deze API publiceert notificaties op het kanaal besluittypen.
Main resource
besluittype
Kenmerken
catalogus: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort.
Resources en acties
Deze API publiceert notificaties op het kanaal informatieobjecttypen.
Main resource
informatieobjecttype
Kenmerken
catalogus: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.
Resources en acties
Handige links
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |