This PHP packages offers an implementation of the 'Zaakgericht Werken' (ZGW) API's, in accordance with the Gemma standards. The library enables developers to easily integrate and access the ZGW API's of various registries.
| Client | 📥 ZRC | 🗂️ ZTC | 📄 DRC | 🔐 Auth |
|---|---|---|---|---|
| OpenZaak | ✅ 1.5.1 |
✅ 1.5.1 |
✅ 1.5.1 |
JWT tokens |
| RxMission | ✅ 1.5.1 |
✅ 1.5.1 |
✅ 1.5.1 |
JWT tokens |
| XXLLNC | ✅ unkown version |
✅ unkown version |
✅ 1.5.1 |
Pre-distributed API key |
| DecosJoin | unknown | unknown | unknown | unknown |
| Procura | unknown | unknown | unknown | unknown |
At a high level, this package can be broken down in three elements:
- Clients: they represent the connection to a registry. For example: OpenZaak.
- Endpoints: an endpoint within a component. For example: Zaken in the ZRC component or Enkelvoudiginformatieobjecten in the DRC component.
- Entities: typed objects of data, usually returned from the API. For example a 'Zaak' or Objectinformatie.
Good to know: names of most endpoints and entities are not translated. Some classes therefore have names that is a mix of Dutch and English.
In most cases you'd:
- Resolve your client of your choice (e.g. OpenZaak)
- Access the endpoint you need through the client (e.g. Zaken)
- Request the entity of your choice through the endpoint (e.g. Zaak)