Skip to content

plone/plone.restapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 7, 2024
16255d9 · Mar 7, 2024
Feb 28, 2024
Oct 31, 2023
Apr 19, 2022
Mar 3, 2024
Apr 1, 2023
Mar 7, 2024
Mar 4, 2017
Apr 20, 2017
Apr 1, 2023
Apr 1, 2023
Jun 2, 2021
Jul 11, 2015
Mar 22, 2022
Mar 3, 2024
Oct 25, 2019
Sep 7, 2023
Jun 3, 2017
Apr 8, 2023
Oct 2, 2022
Feb 22, 2024
Sep 22, 2023
Feb 10, 2024
Oct 1, 2022
Jul 14, 2023
Mar 22, 2022
Apr 18, 2023
Apr 7, 2023
Oct 18, 2023
Apr 7, 2023
Oct 18, 2023
Jun 30, 2023
Oct 28, 2021
Sep 21, 2023
Sep 21, 2023
Jan 14, 2024
Oct 6, 2022
Apr 1, 2023
Mar 3, 2024
Aug 31, 2021
May 17, 2016
May 9, 2022
Oct 1, 2022
Oct 27, 2021
Mar 21, 2020

Repository files navigation

https://github.com/plone/plone.restapi/actions/workflows/tests.yml/badge.svg?branch=main https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=main https://readthedocs.org/projects/pip/badge

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.

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

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

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 which makes it easier to obtain a basic authorization token.

Installation

Install plone.restapi by adding it to your buildout.

[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, 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

Examples

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

Support

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.

License

The project is licensed under the GPLv2.