Projects, Environments & Tokens

Projects and environments

Within each team, projects group related content. Each project has one or more environments that represent stages of your release pipeline.

Default setup

Provisioning creates a Default Project with three environments:

• Development — where you draft widgets and collections in the composer. A starter widget is created here automatically.
• Staging — preview integrations and QA before go-live.
• Production — live content consumed by your apps.

Managing projects

• List — …/p from the team dashboard
• Create — …/p/new
• Edit — …/p/[projectId]/edit

Managing environments

• List — …/p/[projectId]/e
• Create — …/p/[projectId]/e/new
• Environment home — …/p/[projectId]/e/[environmentId] — hub for widgets, collections, and tokens

External app registry

The Apps section (…/apps) registers external applications that consume published RuleCMS content. Each app represents a website, mobile app, or service that will call the public widget API with a token.

• List apps — …/apps
• Create app — …/apps/new
• View / edit — …/apps/[appId] and …/edit

Provisioning creates a Default App automatically. You can register additional apps if multiple consumers need separate token scopes.

API tokens

Each combination of app + project environment has an API token used by your consuming applications. Tokens are managed at …/app-project-env-tokens.

Token rules

• One token is created per environment when the team is provisioned (for the default app).
• Tokens for Development (and any non-Staging / non-Production environment) are stored with a dev. prefix. Staging and Production tokens have no prefix. That prefix tells @rulecms/widget-react to load live drafts instead of published snapshots.
• Tokens can be enabled or disabled — disabled tokens reject public API requests.
• When opening the tokens page from the environment home, query parameters appId and environmentId pre-filter to the relevant token.

Using tokens

Staging / Production: pass the token with a widget's published key. See API Reference.

Development: pass a dev. token with the draft widget key for real-time preview without publishing. See Development Integration.