.. image:: https://github.com/plone/plone.restapi/actions/workflows/tests.yml/badge.svg?branch=main :target: https://github.com/plone/plone.restapi/actions/workflows/tests.yml

.. image:: https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=main :target: https://coveralls.io/github/plone/plone.restapi?branch=main

.. image:: https://readthedocs.org/projects/pip/badge :target: https://plonerestapi.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/v/plone.restapi.svg :target: https://pypi.org/project/plone.restapi/

Introduction

plone.restapi is a RESTful hypermedia API for Plone.

Documentation

https://plonerestapi.readthedocs.io/en/latest/

Getting started

A live demo of Plone 6 with the latest plone.restapi release is available at:

https://demo.plone.org/

An example GET request on the portal root is the following.

.. code-block:: shell

curl -i https://demo.plone.org/++api++ -H "Accept: application/json"

An example POST request to create a new document is the following.

.. code-block:: shell

curl -i -X POST https://demo.plone.org/++api++ \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    --data-raw '{"@type": "Document", "title": "My Document"}' \
    --user admin:admin

.. note::

You will need some kind of API browser application to explore the API.
You will also need to first obtain a basic authorization token.
We recommend using `Postman <https://www.postman.com/>`_ which makes it easier to obtain a basic authorization token.

Installation

Install plone.restapi by adding it to your buildout.

.. code-block:: ini

[buildout]

# ...

eggs =
    plone.restapi

…and then running bin/buildout.

Python / Plone Compatibility

plone.restapi 9 requires Python 3 and works with Plone 5.2 and Plone 6.x.

plone.restapi 8 entered "maintenance" mode with the release of plone.restapi 9 (September 2023). It is not planned to backport any features to this version and we highly recommend to upgrade to plone.restapi 9.

Python versions that reached their end-of-life <https://devguide.python.org/versions/>_, including Python 3.6 and Python 3.7 are not supported any longer.

Use plone.restapi 7 if you are running Python 2.7 or Plone versions below 5.2.

Contribute

• Issue Tracker: https://github.com/plone/plone.restapi/issues
• Source Code: https://github.com/plone/plone.restapi
• Documentation: https://plonerestapi.readthedocs.io/en/latest

Examples

plone.restapi has been used in production since its first alpha release. It can be seen in action at the following sites:

• Zeelandia GmbH & Co. KG: https://www.zeelandia.de (by kitconcept GmbH)
• VHS-Ehrenamtsportal: https://vhs-ehrenamtsportal.de (by kitconcept GmbH)
• German Physical Society: https://www.dpg-physik.de (by kitconcept GmbH)

Support

If you are having issues, please let us know via the issue tracker <https://github.com/plone/plone.restapi/issues>_.

If you require professional support, here is a list of Plone solution providers that contributed significantly to plone.restapi in the past.

• kitconcept GmbH <https://kitconcept.com>_ (Germany)
• 4teamwork <https://www.4teamwork.ch/en>_ (Switzerland)
• CodeSyntax <https://www.codesyntax.com/en>_ (Spain)

License

The project is licensed under the GPLv2.