Account Login & Customer Information
Account Login/Retrieval
Use this API to validate a customer account and obtain a user object with the customer account details and optionally their personal TV settings.
| End Point |
https://api.digiguide.tv/1.2/tv/account/ |
| Supported Responses |
JSON |
| Supported Methods |
GET |
| URI Scheme |
Either HTTP or HTTPS requests are supported. HTTPS is the preferred scheme. |
| User Authentication |
Required |
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
Optional Parameters
| what=channels |
When specified, returns a 'channels' property containing an array of channel information for the customer's channel selection. If the customer has not yet selected any channels, a default selection will be returned with the additional 'user' object property "defaultChannelsUsed" being set to 'true' |
| what=progprefs |
When specified, returns a 'programmePreferences' object containing 3 arrays of programme ID's for programmes the customer has chosen to 'like', 'dislike' or 'hide' |
| device=<string> |
You can specify a unique value pertaining to the specific device being used, for example the UDID for an iOS device; this helps in customer support and should not contain user identifiable data like personal details or an IP address |
Successful Response
{
"success": true,
"user":
{
"userID": 1,
"userKey": 9234,
"screenName": "MyTest",
"firstName": "Joe",
"lastName": "Blogs",
"verified": true,
"email": "mytest_joe_blogs@gmail.com",
"lastUpdatedChannels" : "Wed, 02 Mar 2011 21:42:00 GMT",
"tvCountry" : "United Kingdom",
"tvProvider" : "Sky Digital HD",
"tvRegion" : "WestCountry",
"defaultChannelsUsed" : false,
"channels" : [
{
"id" : 51035,
"name" : "BBC 1 HD",
"category" : "Entertainment",
"epg" : "143",
"shortName" : "",
"selected" : true
},
],
"programmePreferences" : {
{
"like" : [
13040,
47914,
78355,
377560,
467931,
686163,
703064,
786582,
789352
],
"dislike" : [
37691
],
"hide" : []
}
}
}
Account Sign Up
Use this API to create a customer account.
| End Point |
https://api.digiguide.tv/1.2/tv/create/ |
| Supported Responses |
JSON |
| Supported Methods |
POST |
| URI Scheme |
Either HTTP or HTTPS requests are supported. HTTPS is the preferred scheme. |
| User Authentication |
None |
Required Parameters
| appid=<yourappid> |
Your unique and secret Application ID |
| email=<string> |
Valid user e-mail; max 255 characters |
| passhash=<string> |
SHA256 hashed representation of user password; max 64 characters |
| screenname=<string> |
User defined alternate/friendly screen name; max 255 characters |
Optional Parameters
| firstname=<string> |
User first name; max 50 characters |
| lastname=<string> |
User last name; max 50 characters |
| device=<string> |
You can specify a unique value pertaining to the specific device being used, for example the UDID for an iOS device; this helps in customer support and should not contain user identifiable data like personal details or an IP address |
Successful Response
{
"success": true,
"user":
{
"userID": 1,
"userKey": 9234,
"screenName": "MyTest",
"firstName": "Joe",
"lastName": "Blogs",
"verified": true,
"email": "mytest_joe_blogs@gmail.com",
"lastUpdatedChannels" : "Wed, 02 Mar 2011 21:42:00 GMT",
"tvCountry" : "United Kingdom",
"tvProvider" : "Sky Digital HD",
"tvRegion" : "WestCountry"
}
}
User Channels
Use this API to obtain or set a list of channels for the given authenticated user, or return a list of channels for the given country, provider and region.
Please see Channel Information for detailed information.
