Apps

APIs to manage Livefyre Apps that visualize Content in real-time.

Create App

posthttps://api.livefyre.com/{network}/apps/v1/

Create a Livefyre App

Path Parameters
namerequiredtypedescription
networktruestring

Your organization's Livefyre Network, e.g. something.fyre.co

Request Body

Content-Type: application/json

propertytypedescription
titlestring

Title of the App. This will be the display name in Livefyre Studio.

sitesarray
sites.[]string

URN of a Livefyre Site, e.g. "urn:livefyre:studio-qa-0.fyre.co:site=290669"

publishedboolean

Whether the app should be immediately published. This will allow it to be embedded. If not immediately published, a Livefyre Studio user will have to publish the app later before it can be embedded.

elementsarray
elements.[]object

A single part of an app

elements.[].componentstring

ID of the Component that powers this element. It must be one of

  • urn:livefyre:service=designer:component=media-wall
  • urn:livefyre:service=designer:component=trending
  • urn:livefyre:service=designer:component=map
  • urn:livefyre:service=designer:component=poll
  • urn:livefyre:service=designer:component=liveblog
  • urn:livefyre:service=designer:component=chat
  • urn:livefyre:service=designer:component=comments
  • urn:livefyre:service=designer:component=feature-card
  • urn:livefyre:service=designer:component=carousel
  • urn:livefyre:service=designer:component=mosaic
  • urn:livefyre:service=designer:component=storify2
  • urn:livefyre:service=designer:component=upload-button

Responses

201

A new App was created. See the Location header for the URL of the new App.

Headers
  • location -

    URL of the newly created App

Get App

gethttps://api.livefyre.com/{network}/apps/v1/{appId}

Get information about an App

Path Parameters
namerequiredtypedescription
networktruestring

Your organization's Livefyre Network, e.g. something.fyre.co

appIdtruestring

ID of a Livefyre App

Responses

200

Found app

Headers
  • Link -

    Links to related resources. Formatted as described in RFC 5988.

    Known 'rel' values:

    • urn:livefyre:service=studio:link-rel=embed-code - HTML Embed Code for the App.
    • urn:livefyre:service=studio:link-rel=app-details - View in Livefyre Studio
    • urn:livefyre:service=studio:link-rel=app-settings - Edit App Settings
    • urn:livefyre:service=studio:link-rel=app-designer - Edit App Design

Get App Embed Code

gethttps://api.livefyre.com/{network}/apps/v1/{appId}/embed

Get an embed code for an app. By default, html is returned (optionally specify the .html extension). To return an Oembed, simply add a .json extension (for more information, see embed.json endpoint).

Path Parameters
namerequiredtypedescription
networktruestring

Your organization's Livefyre Network, e.g. something.fyre.co

appIdtruestring

ID of a Livefyre App

Responses

200

Generated and returned embed code

Example text/html
"<script type=\"text/javascript\" src=\"https://cdn.livefyre.com/Livefyre.js\"></script><div class=\"lf-app-embed\" data-lf-app=\"18a62841-594d-4e2b-9e9a-b929376fe48c/tagged/published\" data-lf-env=\"prod\" data-lf-read-only=\"\"></div><script>Livefyre.require([\"app-embed#1.0.8\"], function (appEmbed) {appEmbed.loadAll().done(function(embed) {embed = embed[0];if (embed.el.onload && embed.getConfig) {embed.el.onload(embed.getConfig());}});});</script>"

Get App Oembed

gethttps://api.livefyre.com/{network}/apps/v1/{appId}/embed.{ext}

Get an embed or Oembed for an app by content type.

Path Parameters
namerequiredtypedescription
networktruestring

Your organization's Livefyre Network, e.g. something.fyre.co

appIdtruestring

ID of a Livefyre App

exttruestring

Type extension. Use json for an Oembed or html for just the html of the embed.

Responses

200

Generated and returned Oembed

Example application/json
{
  "version": "1.0",
  "type": "rich",
  "provider_name": "Livefyre",
  "provider_url": "https://www.livefyre.com",
  "width": 640,
  "height": null,
  "html": "<script type=\"text/javascript\" src=\"https://cdn.livefyre.com/Livefyre.js\"></script><div class=\"lf-app-embed\" data-lf-app=\"1234\" data-lf-env=\"prod\" data-lf-read-only=\"\"></div><script>Livefyre.require([\"app-embed#1.0.8\"], function (appEmbed) {appEmbed.loadAll().done(function(embed) {embed = embed[0];if (embed.el.onload && embed.getConfig) {embed.el.onload(embed.getConfig());}});});</script>"
}
Example text/html
"<script type=\"text/javascript\" src=\"https://cdn.livefyre.com/Livefyre.js\"></script><div class=\"lf-app-embed\" data-lf-app=\"18a62841-594d-4e2b-9e9a-b929376fe48c/tagged/published\" data-lf-env=\"prod\" data-lf-read-only=\"\"></div><script>Livefyre.require([\"app-embed#1.0.8\"], function (appEmbed) {appEmbed.loadAll().done(function(embed) {embed = embed[0];if (embed.el.onload && embed.getConfig) {embed.el.onload(embed.getConfig());}});});</script>"

Search Apps

gethttps://api.livefyre.com/app-service/v4/{network}/apps/search/

Search for apps by various parameters

Path Parameters
namerequiredtypedescription
networktruestring

Your organization's Livefyre Network, e.g. something.fyre.co

Query Parameters
namerequiredtypedescription
queryfalsestring

Text query that filters the Livefyre Network's Apps by name

idfalsestring

ID of a Livefyre App

collectionIdfalsestring

ID of a Livefyre Collection that is contained in the App

collectionUrlfalsestring

URL of a Livefyre Collection that is contained in the App

articleIdfalsestring

ArticleID of a Livefyre Collection that is contained in the App

typefalsestring

Type of Livefyre Component that is in the App

sortfalsestring

Sort order for results that supports sorting by create date, updated date, content count and participant count

tagfalsestring

Tag of the Livefyre App

Responses

200

Search results

Headers
  • Link -

    Links to related resources. Formatted as described in RFC 5988.

    Known 'rel' values:

    • urn:livefyre:service=studio:link-rel=embed-code - HTML Embed Code for the App.
    • urn:livefyre:service=studio:link-rel=app-details - View in Livefyre Studio
    • urn:livefyre:service=studio:link-rel=app-settings - Edit App Settings
    • urn:livefyre:service=studio:link-rel=app-designer - Edit App Design