APIs to manage Livefyre Apps that visualize Content in real-time.
posthttps://api.livefyre.com/{network}/apps/v1/
Create a Livefyre App
| name | required | type | description |
|---|---|---|---|
| network | true | string | Your organization's Livefyre Network, e.g. something.fyre.co |
Content-Type: application/json
| property | type | description |
|---|---|---|
| title | string | Title of the App. This will be the display name in Livefyre Studio. |
| sites | array | |
| sites.[] | string | URN of a Livefyre Site, e.g. "urn:livefyre:studio-qa-0.fyre.co:site=290669" |
| published | boolean | 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. |
| elements | array | |
| elements.[] | object | A single part of an app |
| elements.[].component | string | ID of the Component that powers this element. It must be one of
|
A new App was created. See the Location header for the URL of the new App.
URL of the newly created App
gethttps://api.livefyre.com/{network}/apps/v1/{appId}
Get information about an App
| name | required | type | description |
|---|---|---|---|
| network | true | string | Your organization's Livefyre Network, e.g. something.fyre.co |
| appId | true | string | ID of a Livefyre App |
Found app
Links to related resources. Formatted as described in RFC 5988.
Known 'rel' values:
| property | type | description |
|---|---|---|
| title | string | Title of the App. This is the display name in Livefyre Studio. |
| sites | array | |
| sites.[] | string | URN of a Livefyre Site that this App belongs to, e.g. "urn:livefyre:studio-qa-0.fyre.co:site=290669" |
| published | boolean | Whether the app is published, which allows it to be embedded. If it is not published, a Livefyre Studio user will have to publish the app before it can be embedded. |
| elements | array | |
| elements.[] | object | A single part of an app |
| elements.[].component | string | ID of the Component that powers this element. It must be one of
|
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).
| name | required | type | description |
|---|---|---|---|
| network | true | string | Your organization's Livefyre Network, e.g. something.fyre.co |
| appId | true | string | ID of a Livefyre App |
Generated and returned embed code
"<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>"gethttps://api.livefyre.com/{network}/apps/v1/{appId}/embed.{ext}
Get an embed or Oembed for an app by content type.
| name | required | type | description |
|---|---|---|---|
| network | true | string | Your organization's Livefyre Network, e.g. something.fyre.co |
| appId | true | string | ID of a Livefyre App |
| ext | true | string | Type extension. Use json for an Oembed or html for just the html of the embed. |
Generated and returned Oembed
{
"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>"
}"<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>"gethttps://api.livefyre.com/app-service/v4/{network}/apps/search/
Search for apps by various parameters
| name | required | type | description |
|---|---|---|---|
| network | true | string | Your organization's Livefyre Network, e.g. something.fyre.co |
| name | required | type | description |
|---|---|---|---|
| query | false | string | Text query that filters the Livefyre Network's Apps by name |
| id | false | string | ID of a Livefyre App |
| collectionId | false | string | ID of a Livefyre Collection that is contained in the App |
| collectionUrl | false | string | URL of a Livefyre Collection that is contained in the App |
| articleId | false | string | ArticleID of a Livefyre Collection that is contained in the App |
| type | false | string | Type of Livefyre Component that is in the App |
| sort | false | string | Sort order for results that supports sorting by create date, updated date, content count and participant count |
| tag | false | string | Tag of the Livefyre App |
Search results
Links to related resources. Formatted as described in RFC 5988.
Known 'rel' values: