Kirby Headless is a plugin for Kirby CMS: JSON pages and KQL queries, served behind one bearer token.
Authentication • KQL • Field Methods • Page Methods
Note
Want a ready-to-use headless-only project? Start from the Kirby Headless Starter.
| I want to… | Use |
|---|---|
| Query content from a frontend over HTTP | KQL endpoint at /api/kql |
| Lock the API behind a token instead of basic auth | kql.auth => 'bearer' + headless.token |
| Resolve UUIDs in blocks and layouts to real objects | $field->toResolvedBlocks() |
| Return JSON straight from a template | JSON templates / __template__ endpoint |
| Compose custom, authenticated API routes | Api::createHandler() + middlewares |
- Kirby 5
Note
Using Kirby 4? Install the v4 release.
composer require johannschopplich/kirby-headlessDownload and copy this repository to /site/plugins/kirby-headless.
For installation, configuration, and usage, see the Kirby Headless documentation.
MIT License © 2022-PRESENT Johann Schopplich