INTRODUCTION

EPG API is used to get the TV program information (EPG data) for linear channels.

Note See also Channels API for additional documentation

API PATH

/api/channels

API METHODS

GET EPG EVENTS

REQUEST

Parameters:

*If lcId (Linear Channel ID) is present, the EPG data for that channel will be returned. Otherwise all channels data for organizationId will be returned.

• Some example calls with various parameters:
  1. To get all events for a channel:
     • http://suite.icareus.com/api/channels?organizationId=15936&lcId=43750
  2. To get events for a channel within a particular time range
     • http://suite.icareus.com/api/channels?organizationId=15936&lcId=43750&from=1361284169&to=1361294169 (Returns all events with start time >= 1361284169 and <= 1361294169)

RESPONSE

CHANNELS/EPG API V1.0 (DEPRECATED)

REQUEST

• Organization ID is hard-coded in the application, i.e. one client will always be making requests with same organization_id.
• If lc_id is absent a list of channels is returned. If present, epg/events for that channel are returned. Other filters apply accordingly (i.e. to the content being returned).
• NOTE: The parameter "return" is for internal/testing purposes only. This will return all channel data, regardless of its release date. By default (i.e. without this parameter), the service only returns data that has release date before/equal-to the request time.

• Some example calls:
  1. To get list of all channels for an organization:
     • http://itvsuite2.icareus.com/xml-connector-portlet/lc-xml-connector?organization_id=15936
  2. To get list of N first channels for an organization:
     • http://itvsuite2.icareus.com/xml-connector-portlet/lc-xml-connector?organization_id=15936&limit=10 (returns channels from index 0-9)
  3. To get channels within a range:
     • http://itvsuite2.icareus.com/xml-connector-portlet/lc-xml-connector?organization_id=15936&start=10&limit=15 (returns channels from index 10-24)
  4. To get all events for a channel:
     • http://itvsuite2.icareus.com/xml-connector-portlet/lc-xml-connector?organization_id=15936&lc_id=43750
  5. To get events for a channel within a particular time range
     • http://itvsuite2.icareus.com/xml-connector-portlet/lc-xml-connector?organization_id=15936&lc_id=43750&from=1361284169&to=1361294169 (Returns all events with start time >= 1361284169 and <= 1361294169)
  6. To get token protected URL for SmartJog for LMTV
     • https://suiterc.icareus.com:4443/json-connector-portlet/lc-json-connector?organizationId=52910&protection=smartjoglmtv&url=http%3A%2F%2Fchkg.tdf-cdn.com%2F8336%2Findex.m3u8 (Returns just the token protected URL: http://chkg.tdf-cdn.com/8336/de38ae92fcf4de9d6d4b144cd88f01f8/52b84d0b/index.m3u8)

XML RESPONSE EXAMPLES

JSON RESPONSE EXAMPLES

STREAM TOKEN PROTECTION

It is possible to define that stream is token protected for a channel.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE eit SYSTEM "eit.dtd">
<linear-channel-list>
	<channel service-id="52957" network-id="1" on-id="1" ts-id="1" broadcast-sid="1" logical-channel="1">
		<title>LMTV</title>
		<description>LMTV</description>
		<icon-small-url>https://213.157.93.29:4443/</icon-small-url>
		<icon-medium-url>https://213.157.93.29:4443/</icon-medium-url>
		<icon-large-url>https://213.157.93.29:4443/</icon-large-url>
	        <device-list>
		        <device id="52958">
		        	<name>1280x720 (4564 Kbps)</name>
                		<video-url>http://chkg.tdf-cdn.com/8336/index.m3u8</video-url>
		        	<protection>
					<type>smartjoglmtv</type>
		        	</protection>
	        	</device>
	        </device-list>
	</channel>
</linear-channel-list>

{"channels":
	[{"logicalChannel":1,
	"imageLarge":"",
	"title":"LMTV",
	"imageMedium":"",
	"serviceId":52957,
	"description":"LMTV",
	"tsId":1,
	"networkId":1,
	"onId":1,
	"devices":
		[{"protection":{"type":"smartjoglmtv"},
		"id":52958,
		"name":"1280x720 (4564 Kbps)",
		"url":"http://chkg.tdf-cdn.com/8336/index.m3u8"}],
	"imageSmall":"",
	"bsId":1}]
}

If the stream is token protected, then every time the stream should be played a new URL should be requested from the server. The parameter "protection" defines the type of the protection. The parameter "url" defines the encoded URL that should be used in token generation. The response will contain the token protected URL to play.
Example request: http://suite.icareus.com/json-connector-portlet/lc-json-connector?protection=smartjoglmtv&url=http%3A%2F%2Fchkg.tdf-cdn.com%2F8336%2Findex.m3u8
Example responce: http://chkg.tdf-cdn.com/8336/de38ae92fcf4de9d6d4b144cd88f01f8/52b84d0b/index.m3u8