oneground/notificaties-api repository overview

⁠OneGround Notificaties API

⁠Featured Tags

docker pull ghcr.io/oneground/notificaties-api:<version>

The complete list of available versions for the OneGround Notificaties API is maintained on their GitHub versions page⁠.

⁠About

This is the official container image for the OneGround Notificaties API. It's an open-source project that implements the official VNG Notificaties API⁠ standard used in the Netherlands.

⁠What is OneGround Notificaties API?

This OneGround implementation provides a standardized interface that functions as a central message bus for publishing and subscribing to event notifications. Designed to be the core communication channel for the ZGW ecosystem, the Notificaties API allows components like the Zaken API, Documenten API, and Besluiten API to broadcast significant events as they occur. By enabling a decoupled, event-driven architecture, this API allows other applications and listeners to subscribe and react to these events asynchronously. This approach enhances system resilience, scalability, and flexibility.

By adhering to the VNG standard for notifications, the OneGround Notificaties API ensures that all inter-system communication is reliable and standardized, creating a responsive and interoperable data landscape for government operations.

For more details and implementation guidelines, visit the OneGround ZGW APIs GitHub repository⁠.

⁠ZGW API Versions Supported by OneGround

You can find all supported versions in the OneGround API Versions list⁠.

⁠Dependencies

The OneGround Notificaties API depends on:

• OneGround Autorisaties API⁠
• OneGround Documenten API⁠
• OneGround Documenten Listener⁠
• OneGround Notificaties Listener⁠

⁠How to use this image

docker run -it -p 8080:80 ghcr.io/oneground/notificaties-api:<version>

⁠Configuration

For a real-world setup, you will need to provide environment variables for connecting to a database and other services. It's recommended to use docker-compose for a more robust setup.

⁠Support

View issues related to this image in our GitHub issues⁠.

If you encounter any bugs or security issues with the project, please file an issue in our GitHub repo⁠.

⁠Feedback

To provide feedback on this project visit our GitHub repository⁠ to file issues, open pull requests, contribute to discussions, and more.

⁠License

This project is licensed under the BSD 3-Clause License. See the LICENSE⁠ file for more details.