plone.restapi is a RESTful hypermedia API for Plone.

https://plonerestapi.readthedocs.org

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

https://plonedemo.kitconcept.com

Example GET request on the portal root

curl -i https://plonedemo.kitconcept.com -H "Accept: application/json"

Example POST request to create a new document

curl -i -X POST https://plonedemo.kitconcept.com -H "Accept: application/json" -H "Content-Type: application/json" --data-raw '{"@type": "Document", "title": "My Document"}' --user admin:admin

Install plone.restapi by adding it to your buildout:

[buildout]

...

eggs =
    plone.restapi

and then running bin/buildout

When installing plone.restapi version 7.x.x in Plone 4 you may need to add the following version pins to your buildout:

[versions]
PyJWT = 1.7.1

six = 1.11.0
attrs = 21.2.0
plone.rest = 1.6.2
plone.schema = 1.3.0
# Last pyrsistent version that is python 2 compatible:
pyrsistent = 0.15.7

# Required by:
# jsonschema==3.2.0
functools32 = 3.2.3.post2

# Required by:
# plone.schema==1.3.0
jsonschema = 3.2.0

# Required by:
# importlib-metadata==1.3.0
pathlib2 = 2.3.5

# Required by:
# pathlib2==2.3.5
scandir = 1.10.0

# plone.app.contenttypes > 1.0
plone.app.contenttypes = 1.1.9

importlib-metadata = 2.1.3
zipp = 1.2.0
configparser = 4.0.2
contextlib2 = 0.6.0.post1

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

plone.restapi is used in production since the 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)
• Universitat Politècnica de Catalunya: https://www.upc.edu (by kitconcept GmbH)

If you are having issues, please let us know via the issue tracker.

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

• kitconcept GmbH (Germany)
• 4teamwork (Switzerland)
• CodeSyntax (Spain)

The project is licensed under the GPLv2.