.. _api_index:

==================
API-specifications
==================

Open Notificaties adheres to the API-specifications as described by the `VNG API standard
for the "Notificaties API"`_.

.. _`VNG API standard for the "Notificaties API"`: https://vng-realisatie.github.io/gemma-zaken/standaard/notificaties/

Supported API versions
======================

The following API's are available in Open Notificaties:

======================  ==========================================
API                     Specification version(s)
======================  ==========================================
`Notificaties API`_     `1.0 <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-zaak/open-notificaties/1.0.0/src/openapi.yaml>`__
======================  ==========================================

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


Deviation from the standards
----------------------------
 
While Open Notificaties supports above mentioned standard it also provides extra features, which can enrich
the client experience. The full list of them is documented :ref:`here <api_experimental>`.
 
Reference
---------

.. toctree::
   :maxdepth: 1
   
   experimental