REST API
Contents
REST API#
A RESTful API for Plone.
Introduction#
plone.restapi is a RESTful hypermedia API for Plone.
Documentation#
Getting started#
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
Note
You will need some kind of API browser application to explore the API. We recommend using Postman.
Installation#
Install plone.restapi by adding it to your buildout:
[buildout]
...
eggs =
plone.restapi
and then running bin/buildout
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 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/ca (by kitconcept GmbH)
Support#
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)
License#
The project is licensed under the GPLv2.