Zappiti Player API
Move your app forward with the Zappiti Player API. Use http://your-player-ip:8990/ as base URL for your requests.
Version: 4.24.253
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /CheckZappitiService
(checkZappitiServicePost)
Check if Zappiti Service app status on the player
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
CheckZappitiServiceResult
Up
post /ConnectionDetails
(connectionDetailsPost)
Get user's login details
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Email" : "Email",
"ServerIp" : "ServerIp",
"AuthKey" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"Collection" : "Collection",
"ErrorCode" : { },
"ServerPort" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
ConnectionDetailsResult
Up
post /InstallZappitiService
(installZappitiServicePost)
Open a popup that allow the user to install Zappiti Service, if not already installed
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
InstallZappitiServiceResult
(isAlivePost)
Get server status
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
IsAliveResult
(isPlayingPost)
Check if a video is playing
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { },
"IsPlaying" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
IsPlayingResult
(lastMediaPost)
Get informations about last media playback
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Media" : {
"BackgroundUrl" : "BackgroundUrl",
"TvShowName" : "TvShowName",
"Title" : "Title",
"TechnicalInfo" : {
"Container" : "Container",
"Runtime" : 5,
"AudioChannels" : "AudioChannels",
"VideoAspectRatio" : "VideoAspectRatio",
"VideoFramerate" : "VideoFramerate",
"Subtitles" : "Subtitles",
"VideoDefinition" : "VideoDefinition",
"AudioFormatProfile" : "AudioFormatProfile",
"AudioLanguages" : "AudioLanguages",
"VideoCodec" : "VideoCodec",
"AudioCodec" : "AudioCodec"
},
"PosterUrl" : "PosterUrl",
"Actors" : [ "Actors", "Actors" ],
"Aired" : 5,
"Synopsis" : "Synopsis",
"SeenState" : { },
"AllowedForChildren" : true,
"Rating100" : 1,
"Episode" : 0,
"Type" : { },
"Directors" : [ "Directors", "Directors" ],
"Id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"Season" : 6
},
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
LastMediaResult
(launchAppPost)
Launch app by his name/packagename
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
LaunchAppResult
(mediaPost)
Request media details for the current Zappiti Collection
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"Media" : {
"BackgroundUrl" : "BackgroundUrl",
"TvShowName" : "TvShowName",
"Title" : "Title",
"TechnicalInfo" : {
"Container" : "Container",
"Runtime" : 5,
"AudioChannels" : "AudioChannels",
"VideoAspectRatio" : "VideoAspectRatio",
"VideoFramerate" : "VideoFramerate",
"Subtitles" : "Subtitles",
"VideoDefinition" : "VideoDefinition",
"AudioFormatProfile" : "AudioFormatProfile",
"AudioLanguages" : "AudioLanguages",
"VideoCodec" : "VideoCodec",
"AudioCodec" : "AudioCodec"
},
"PosterUrl" : "PosterUrl",
"Actors" : [ "Actors", "Actors" ],
"Aired" : 5,
"Synopsis" : "Synopsis",
"SeenState" : { },
"AllowedForChildren" : true,
"Rating100" : 1,
"Episode" : 0,
"Type" : { },
"Directors" : [ "Directors", "Directors" ],
"Id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"Season" : 6
},
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
MediaResult
(menuPost)
Request the content of a menu for the current Zappiti Collection
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { },
"Menu" : {
"Buttons" : [ {
"Type" : { },
"Text" : "Text",
"Id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"Image" : "Image"
}, {
"Type" : { },
"Text" : "Text",
"Id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"Image" : "Image"
} ],
"Id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
MenuResult
(startVideoPost)
Start the playback
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
StartVideoResult
Up
post /StartZappitiService
(startZappitiServicePost)
Start Zappiti Service if not started yet
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ErrorCode" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
StartZappitiServiceResult
[ Jump to Methods ]
Table of Contents
Button
-
ButtonType
-
CheckZappitiServiceRequest
-
CheckZappitiServiceResult
-
ConnectionDetailsRequest
-
ConnectionDetailsResult
-
ErrorCode
-
InstallZappitiServiceRequest
-
InstallZappitiServiceResult
-
IsAliveRequest
-
IsAliveResult
-
IsPlayingRequest
-
IsPlayingResult
-
LastMediaRequest
-
LastMediaResult
-
LaunchAppRequest
-
LaunchAppResult
-
Media
-
MediaRequest
-
MediaResult
-
MediaType
-
Menu
-
MenuRequest
-
MenuResult
-
MenuType
-
PictureTypeEnum
-
SeenState
-
StartVideoRequest
-
StartVideoResult
-
StartZappitiServiceRequest
-
StartZappitiServiceResult
-
TechnicalInfo
-
Check if Zappiti Service app status on the player
AuthKey
Collection
ServerIp
ServerPort
Email
ErrorCode
Open a popup that allow the user to install Zappiti Service, if not already installed
Get informations about last media playback
Id
Title
PosterUrl
BackgroundUrl
Type
SeenState
AllowedForChildren
Episode
Season
TvShowName
Synopsis
Rating100
Aired (optional)
Actors
Directors
TechnicalInfo
Request media details for the current Zappiti Collection
Request the content of a menu for the current Zappiti Collection
Start Zappiti Service if not started yet
Container
VideoAspectRatio
VideoDefinition
VideoCodec
VideoFramerate
AudioChannels
AudioCodec
AudioLanguages
Subtitles
Runtime
AudioFormatProfile