apps

Render a catalog app

Get the rendered HTML for one app from the app catalog. This is the same output used by the player and by the content management system preview.

Notes.

  • HTML for an iframe, with a strict content security policy; who may frame it is limited to Brix players and the console.
get/v1/apps/{key}/render

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/apps/{key}/render
  • Auth: none required

Path parameters

keystring required

The app's catalog key.

Query parameters

configstring

The app's settings as a JSON string (at most 8 KB; invalid JSON renders the defaults).

langstring

BCP 47 language tag for the app's text (default en-US).

brandstring

A brand kit as a JSON string, for apps that follow the brand.

dtstring

An app data token, for an app bound to a data source (dataSourceId in config).

Response

Success. The body is the file itself.

Changes

No recorded changes to this operation across all 2 revisions of this API.