Sign inSign up

oneground/catalogi-api

By oneground

•Updated about 1 year ago

OneGround implementation of ZGW Catalogi API (from Netherlands VNG standard)

Integration & delivery
API management
0

12

oneground/catalogi-api repository overview

⁠OneGround Catalogi API

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

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

⁠About

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

⁠What is OneGround Catalogi API?

This OneGround implementation provides a standardized interface for managing and exposing different types of catalogs, allowing applications to retrieve information about case types, decision types, and information object types. Designed for seamless integration with other core ZGW components such as the Zaken API, Besluiten API, and Documenten API, this process ensures that all government processes are based on the correct and up-to-date definitions. By adhering to VNG standards, the OneGround Catalogi API promotes interoperability and a unified approach to data management, creating a cohesive 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 Zaken API depends on:

⁠How to use this image

docker run -it -p 8080:80 ghcr.io/oneground/catalogi-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.

Tag Summary

No tags have been pushed to this repository yet.