Getting Started

Welcome, this documentation shows all available endpoints of the internal CanPi API. Through the API it is possible to manage the complete system. Because of that CanPihas some reserved paths which are needed by the system.

/backend
Endpoints for the system configuration
/consumer
Endpoints for the consumer i.e. register new accounts or create new apps
/doc
Endpoints for the documentation
/authorization
Endpoints for the consumer to get i.e. information about the user itself and to revoke an obtained access token
/export
Endpoints to export the documentation into other formats i.e. swagger

Apps

The following apps are working with the CanPi API.

Backend

The backend app is the app where the administrator can configure the system. The app is located at /fusio/.

Did you find this article useful?

  • Backend

    This chapter contains information about the backend. The following pages are extracted from the onli...
  • Development

    Action The src/ folder contains the action code which is executed if a request arrives at ...