Zum Inhalt springen
Ergon Code

Ergon CMS · Dokumentation

Ergon CMS documentation

Install Ergon CMS, build plugins, and connect your own iOS and Android apps through the Site API.

Die Entwickler-Dokumentation gibt es auf Englisch.

Ergon CMS is a Laravel-based content management system with a plugin catalogue for shops, bookings, events, memberships and more. Every installation needs a licence key, which only Ergon Code issues; one key unlocks the CMS and the plugins assigned to it.

Where to start

You want to … Read
Put Ergon CMS on a server Installation
Write a plugin, or extend one Plugins
Build an app for a site's customers Site API and Flutter apps
Build tools for the site's team Staff API

Two APIs, two audiences

The Site API (/api/site/v1) is for the visitors of a website: published pages and posts, the shop with cart and checkout, bookings, event tickets, membership content, the customer's account. Public reads need no key; customers sign in with email, a passkey, Apple or Google. Every installation describes its own Site API at /api/site/v1/openapi.json, with exactly the plugins that are active there.

The Staff API (/api/v1) is for the people running the site: the Ergon app, content editing, the inbox, orders. It needs a staff token with abilities, created under Settings → API.

A customer token never opens a staff route, and the other way round is not needed: staff use their own app.

Versions

Both APIs are version 1. Changes inside a version only add things — new fields, new endpoints, new optional parameters. Anything that goes away is announced first: the route keeps working and answers with Deprecation: true, a Sunset date and a Link to its successor. The API Monitor plugin shows which apps (by X-App-Version) still call it.