Skip to content

REST API of the erupt framework: every endpoint the admin UI calls, usable by any client.

Authentication. POST /erupt-api/login returns a token (token field when pass is true). Server-to-server callers use GET /erupt-api/open-api/create-token with an appid and secret instead. Send the token in the token request header. Endpoints opened by the browser or by an editor (template pages, editor uploads) cannot set headers and take the same value as the _token query parameter. An expired or missing token answers 401, a missing menu or erupt permission answers 403.

The erupt header. Data, build, component, file and export endpoints are scoped to one @Erupt class. The erupt header carries its simple class name and must match the {erupt} path segment, or name the parent erupt when the path addresses a nested erupt (tab, sub-form, reference).

Errors. Business errors come back as HTTP 500 with an R body: success is false, message holds the text to show and promptWay tells the UI how to show it.

External Documentation​

Erupt documentation

Servers​

https://demo.erupt.xyzPublic demo
http://localhost:8080Local development

Released under the Apache-2.0 License.