README

Token-authenticated REST API mirroring the Pushword admin — manage Pages, Media and redirections programmatically, with an OpenAPI description.

Features

• REST endpoints for Page, Media and page redirections.
• Bearer-token auth against the User apiToken (pw:user:token to fetch one).
• OpenAPI-described, machine-readable docs endpoint.
• Built for scripted workflows and external tooling (CI, headless editing).

Installation

composer require pushword/api

Documentation

Visit pushword.piedweb.com/extension/api and media-api.

The Pushword ecosystem

Pushword is a modular CMS — one Symfony bundle for the core and one bundle per feature. Pick only what you need:

Core

• pushword/core — Symfony-based CMS core: Page, Media & User entities, Markdown + Twig rendering.

Editing & admin

• pushword/admin — EasyAdmin interface to manage pages, media and users.
• pushword/admin-block-editor — Gutenberg-like block editor (stores Markdown).
• pushword/advanced-main-image — Hero images & main-image format control.
• pushword/template-editor — Edit Twig templates online.
• pushword/snippet — Reusable content fragments & components.

Content & workflow

• pushword/flat — Flat-file (Markdown + Git) CMS mode.
• pushword/version — Page & snippet versioning.
• pushword/page-update-notifier — Email alerts on content changes.
• pushword/conversation — Comments, contact & newsletter forms.

Publishing & performance

• pushword/static-generator — Export a static website (GitHub Pages, Apache, FrankenPHP).
• pushword/search — SQLite full-text search (Loupe), zero infra.
• pushword/page-scanner — Find dead links, 404s, redirects & TODOs.
• pushword/api — Token-authenticated REST API. (this package)

Tooling

• pushword/installer — Project & package installer.
• pushword/js-helper — Front-end JavaScript helpers.

Full list and guides on pushword.piedweb.com/extensions.

Contributing

If you're interested in contributing to Pushword, please read our contributing docs before submitting a pull request.

Credits

• PiedWeb
• All Contributors

License

The MIT License (MIT). Please see License File for more information.