plone.restapi is a RESTful hypermedia API for Plone.
https://plonerestapi.readthedocs.io/en/latest/
A live demo of Plone 6 with the latest plone.restapi release is available at:
An example GET request on the portal root is the following.
curl -i https://6.demo.plone.org/ -H "Accept: application/json"An example POST request to create a new document is the following.
curl -i -X POST https://6.demo.plone.org/ \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_BASIC_AUTH_TOKEN" \
--data-raw '{"@type": "Document", "title": "My Document"}' \
--user admin:adminNote
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 which makes it easier to obtain a basic authorization token.
Install plone.restapi by adding it to your buildout.
[buildout]
# ...
eggs =
plone.restapi…and then running bin/buildout.
- 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 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)
- Universitat Politècnica de Catalunya: https://www.upc.edu/en (by kitconcept GmbH)
If you are having issues, please let us know via the issue tracker.
If you require 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.