.. _introduction_index:

Introduction
============

**Open Notificaties** is a modern, open-source messaging service that implements the
`VNG API standard for the "Notificaties API"`_ in line with the `Common Ground`_ model.
Among others, it can be used in combination with `Open Zaak`_ which implements the
`VNG standards for "API's voor Zaakgericht werken"`_ that require a Notificaties API.

.. _`Common Ground`: https://commonground.nl/
.. _`Open Zaak`: https://github.com/open-zaak/open-zaak/
.. _`VNG API standard for the "Notificaties API"`: https://vng-realisatie.github.io/gemma-zaken/standaard/notificaties/
.. _`VNG standards for "API's voor Zaakgericht werken"`: https://vng-realisatie.github.io/gemma-zaken/standaard/

Open Notificaties exposes a `Notificaties API`_ (notifications) to route privacy-safe
messages from publishers to subscribers.

.. _`Notificaties API`: https://vng-realisatie.github.io/gemma-zaken/standaard/notificaties/

**Open Notificaties** is based on the `API reference implementations by VNG Realisatie`_
to create a production-grade product that can be used by municipalities.

.. _`API reference implementations by VNG Realisatie`: https://github.com/VNG-Realisatie/gemma-zaken
.. _`Documentatie`: https://open-notificaties.readthedocs.io/en/latest/


.. toctree::
   :maxdepth: 1
   :caption: Further reading

   architecture
   uml-diagram
   team
   open-source
   versioning