REST token

Result: another site reads published pages with Bearer auth. This token cannot write pages. Requires PageBuilder Pro. The Free Public API (api.php) stays separate.

Before you start

1. pagebuilder_rest_api_enabled is on.
2. PageBuilder Pro is installed. Tokens are issued on the API tokens tab.

Steps

1. In the CMP API tokens tab issue a token. The secret is shown once. pagebuilder_rest_tokens keeps the prefix and the hash.
2. Grant scopes pages.read and, if you need the type catalog, catalog.read.
3. Request:

GET /assets/components/pagebuilder/api/v1.php?path=/pages/42
Authorization: Bearer <secret>

Scope	Routes
pages.read	GET /pages, GET /pages/{id-or-alias}
catalog.read	GET /health, GET /catalog/sections

The page list does not include the document body. A repeat with If-None-Match returns 304.

GET /openapi.json on the same v1.php does not require a Bearer token. Without a token the spec is built with scopes catalog.read and pages.read. The token secret is not part of the spec. REST and Pro must be on, otherwise the response is 404.

A revoked token returns 401. pagebuilder_rest_throttle_per_minute (default 120) returns 429 and Retry-After when the limit is passed.

Example fields

Use the id or alias of a published resource.

Scope pages.read only: GET /pages/42 returns the document. GET /catalog/sections without catalog.read is not available. With both scopes the type catalog opens on the same Bearer token.

What to check

The first request with the secret returns the page body and an ETag header. A repeat with If-None-Match returns 304. After revoke the same secret returns 401.

Rollback

Revoke the token on the API tokens tab.

See also

• REST API v1
• Public API