API Documentation

The aeppic server is fully accessible via a REST Api. Everything that aeppic can do is accessible via the API and is used by any service, including the webapp.

Each running instance has a live documentation endpoint while the server is running.

http[s]://<server>/api/v4/documentation

Undocumented Routes

All v4 routes are documented in here, previous routes are being migrated to v4, but are not listed here yet. Documentation for those non-versioned routes (v3) are available as a PDF on request.

In order to interact with the API the user can either use direct HTTP calls (e.g via curl) or use the aeppic javascript module. That module can be used from Browsers or Node.js scripts and contains all client accessible features of the API. That includes the ability to render the full web application.

Base URL

All routes described are relative to the base url /api/v4/

REST Routes

All available routes interface is documented in the REST Documentation.

Swagger

The @aeppic/api project uses Swagger as part of the build process to create the markdown documentation, but the raw swagger yaml file is also available at Swagger Raw YAML.

It can be helpful to access it for processing with other tools.