https://github.com/plone/plone.restapi
RESTful API for Plone.
https://github.com/plone/plone.restapi
hypermedia-api plone python rest rest-api
Last synced: about 2 months ago
JSON representation
RESTful API for Plone.
- Host: GitHub
- URL: https://github.com/plone/plone.restapi
- Owner: plone
- Created: 2014-04-26T08:59:40.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-05-13T10:48:47.000Z (about 2 months ago)
- Last Synced: 2025-05-15T11:02:15.459Z (about 2 months ago)
- Topics: hypermedia-api, plone, python, rest, rest-api
- Language: Python
- Homepage: http://plonerestapi.readthedocs.org/
- Size: 45.4 MB
- Stars: 96
- Watchers: 189
- Forks: 87
- Open Issues: 225
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/plone/plone.restapi/actions/workflows/tests.yml)
[](https://coveralls.io/github/plone/plone.restapi?branch=main)
[](https://plonerestapi.readthedocs.io/en/latest/)
[](https://pypi.org/project/plone.restapi/)
# Introduction
`plone.restapi` is a RESTful hypermedia API for Plone.
# Documentation
# Getting started
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.
```shell
curl -i https://demo.plone.org/++api++ -H "Accept: application/json"
```
An example POST request to create a new document is the following.
```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
`plone.restapi` is included in Plone 6 if you install the `Plone` package.
If it is not installed, add it using requirements.txt or as a dependency of another package.
# 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:
- Source Code:
- Documentation:
# 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: (by kitconcept
GmbH)
- VHS-Ehrenamtsportal: (by kitconcept
GmbH)
- German Physical Society: (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.