Koppelprofiel Zaaksysteem API

Met deze koppeling kan een externe partij gegevens uit het zaaksysteem uitlezen en/of het zaaksysteem berichten aan een externe partij sturen.

Instellingen

Zie ook de Zaaksysteem API Manual: https://<domeinnaam>/man/Zaaksysteem::Manual::API::V1.

Titel	Omschrijving
Versie	De versie van dit koppelprofiel
API sleutel	De unieke API sleutel waarmee de externe partij kan authenticeren
Medewerker	De externe partij heeft hetzelfde toegangsniveau als de geselecteerde gebruiker: Zaken raadplegen en wijzigingen aan zaken aanbrengen. Eventuele wijzigingen die de externe partij binnen zaaksysteem uitvoert zullen namens deze gebruiker gedaan worden.
Toegangsniveau	Het toegangsniveau dat deze API verschaft: Raadplegen: De externe partij mag gegevens uitlezen Behandelen: De externe partij mag gegevens uitlezen en wijzigingen uitvoeren Let op: Deze instelling is onderhevig aan de rechten van de medewerker. Als de medewerker enkel raadpleegrechten heeft zal de instelling 'Behandelen' deze rechten op 'Raadplegen' houden. Als de medewerker behandelrechten heeft zal de instelling 'Raadplegen' de rechten juist beperkt houden tot 'Raadplegen'.
Zoekopdracht	Standaard verschaft de API toegang tot de volgende metainformatie van een zaak: case.number Zaaknummer case.status Zaakstatus case.subject_external Extra informatie PIP case.phase Zaakfase case.result Zaakresultaat case.date_of_registration Registratiedatum case.date_target Streefafhandeldatum Deze informatieset wordt uitgebreid met alle informatie die zichtbaar is binnen de geselecteerde zoekopdracht (dus op basis van de geselecteerde filters en kolommen).
Trigger URL	De URL waar de externe partij berichtgeving van zaaksysteem op moet ontvangen. Zie ook: Regel - Extern systeembericht Let op: Dit moet een https:// zijn.
Trigger CA Certificaat	Eventueel het certificaat voor de trigger URL
API URI
Example: CSV via powershell	Windows commando: powershell -ExecutionPolicy unrestricted -Command "$cmd = (New-Object Net.WebClient); $cmd.Headers.Add(\"API-Interface-Id\",\"<interface_id>\"); $cmd.Headers.Add(\"API-Key\",\"<api_key>\"); $cmd.DownloadString(\"https://<omgeving>/app/api2csv\"); Met bovenstaand commando kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.
Examlple: CSV via Curl	Unix commando curl --header "API-Interface-Id: <interface_id>" --header "API-Key: <api_key>" https://<omgeving>/app/api2csv Met bovenstaand commando kan de output van de ingestelde zoekopdracht geëxporteerd worden als CSV.