Skip to content

Frontend Server API

Kenley Cheung edited this page Feb 1, 2015 · 1 revision

Summary

The Frontend API is the interface used by the concerto-frontend application to get screen template, layout, and field information that is used to render the Concerto frontend (Example).

API Endpoints

Screens

Get frontend HTML page for screen

GET http://nightly.concerto-signage.org/frontend/<SCREEN ID>
GET http://nightly.concerto-signage.org/frontend/1

Request

Parameter Possible Values
SCREEN ID Numeric screen identifier

This URL is meant to be opened in a full-screen web browser, Android WebView, or iOS/Mac OS X UIWebView. The screen id is either provided by the user or returned from the Bandshell configuration process.

Get Frontend configuration for screen

GET http://nightly.concerto-signage.org/frontend/<SCREEN ID>/setup.json
GET http://nightly.concerto-signage.org/frontend/1/setup.json

Request

Parameter Possible Values
SCREEN ID Numeric screen identifier

This endpoint returns a JSON blob containing screen information.

Response

Parameter Possible Values
id Numeric screen identifier
name User-defined name for screen
template JSON hash for template