REST

REST APIs connect applications, scripts, and automation to QUIQQER through HTTP. The Core REST API is available from QUIQQER Core 2.34 and provides access to users, groups, projects, sites, media, permissions, and system operations.

Install quiqqer/rest to expose REST endpoints. Core provides its own endpoints; the REST package supplies the HTTP server and provider integration. The Core API also uses quiqqer/oauth-server for bearer-token authentication.

Packages and Responsibilities

Package	Responsibility
quiqqer/core 2.34 or later	Core resources and their operations.
quiqqer/rest	HTTP routing, configurable API base path, and API discovery.
quiqqer/oauth-server	OAuth access tokens and manually created API tokens.

The Core API is included in Core. It does not require quiqqer/core-rest; Core declares that legacy endpoint package incompatible.

API Address

With the default REST configuration, Core resources start at:

https://www.example.com/api/quiqqer/core

The address consists of the installation host, the configurable REST base path (/api by default), and the Core namespace (/quiqqer/core). Other packages can register their own REST providers.

Examples:

Resource	Request
Users	GET /api/quiqqer/core/users
Groups	GET /api/quiqqer/core/groups
Projects	GET /api/quiqqer/core/projects
German sites in project demo	GET /api/quiqqer/core/projects/demo/de/sites
Media in project demo	GET /api/quiqqer/core/projects/demo/media

Start Here

1. Follow Setup and Authentication to install the packages and configure an active user, token scopes, and permissions.
2. Use Requests and Responses for HTTP methods, examples, pagination, bulk actions, and uploads.
3. Find resource paths in the Core API reference.

REST requests run with the authenticated user's QUIQQER permissions. Enabling a token scope does not grant the underlying permission to read, edit, or delete an object.