Warning: Beta version - API may change in the next releases!
The REST API module provides a generic interface to various subsystems of the HumHub platform.
You can find a full list of available API endpoints in the Usage manual
After installation make sure to set an API key at
Administration -> Modules -> Installed -> Rest API.
Following RESTful API endpoints are available.
The base url for all APIs is:
/docs/htmlcontains HTML rendered documentations for all available API endpoints.
You can find Swagger documentation files in the
/docs/swagger directory of this module.
/docs/postman contains a PostMan collection with all available requests.
To completely adapt the API documentation after a change, the following steps are necessary.
The Swagger documentation is located in the folder
/docs/swagger, you need to rebuild the html documentation
/docs/html which is based on the Swagger YAML files.
To create a HTML documentation you need to install the
redoc-cli NPM package.
Build HTML documentation:
cd docs/swagger ./build-all.sh
Also add examples to the PostMan API request collection located in the folder: