.. _api_index:

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

The Objects API and Objecttypes API are scheduled to be a `recommended standard
as of March 1, 2022`_. Their specifications can be found below.

======================  ==========================================
API                     Specification version(s)
======================  ==========================================
`Objecttypes API`_      2.2.2 (
                        `Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.4.1/src/objecttypes/api/v2/openapi.yaml>`__,
                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objecttypes-api/3.4.1/src/objecttypes/api/v2/openapi.yaml>`__
                        )
`Objects API`_          2.6.0 (
                        `Redoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.6.0/src/objects/api/v2/openapi.yaml>`__,
                        `Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/objects-api/3.6.0/src/objects/api/v2/openapi.yaml>`__
                        )
======================  ==========================================

See their respective repositories for the latest and previous versions.

.. _`recommended standard as of March 1, 2022`: https://commonground.nl/news/view/0d7ff0a6-e960-412b-9a83-33bb1810c67d/twee-nieuwe-standaardverklaringen-deze-apis-maken-het-samenwerken-makkelijker-in-2022
.. _`Objecttypes API`: https://github.com/maykinmedia/objecttypes-api
.. _`Objects API`: https://github.com/maykinmedia/objects-api


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

   usage
   postman
   performance
   compliancy/api-strategy
   compliancy/vng