Zappiti Player API

Move your app forward with the Zappiti Player API. Use http://your-player-ip:8990/ as base URL for your requests.
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 4.24.253
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
post /CheckZappitiService
(checkZappitiServicePost)
Check if Zappiti Service app status on the player

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CheckZappitiServiceRequest (required)
Body Parameter —

Return type

CheckZappitiServiceResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body ConnectionDetailsRequest (required)
Body Parameter —

Return type

ConnectionDetailsResult

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body InstallZappitiServiceRequest (required)
Body Parameter —

Return type

InstallZappitiServiceResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

InstallZappitiServiceResult
Up 
post /IsAlive
(isAlivePost)
Get server status

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body IsAliveRequest (required)
Body Parameter —

Return type

IsAliveResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IsAliveResult
Up 
post /IsPlaying
(isPlayingPost)
Check if a video is playing

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body IsPlayingRequest (required)
Body Parameter —

Return type

IsPlayingResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { },
  "IsPlaying" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IsPlayingResult
Up 
post /LastMedia
(lastMediaPost)
Get informations about last media playback

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LastMediaRequest (required)
Body Parameter —

Return type

LastMediaResult

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

LastMediaResult
Up 
post /LaunchApp
(launchAppPost)
Launch app by his name/packagename

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body LaunchAppRequest (required)
Body Parameter —

Return type

LaunchAppResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

LaunchAppResult
Up 
post /Media
(mediaPost)
Request media details for the current Zappiti Collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MediaRequest (required)
Body Parameter —

Return type

MediaResult

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

MediaResult
Up 
post /Menu
(menuPost)
Request the content of a menu for the current Zappiti Collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MenuRequest (required)
Body Parameter —

Return type

MenuResult

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

MenuResult
Up 
post /StartVideo
(startVideoPost)
Start the playback

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StartVideoRequest (required)
Body Parameter —

Return type

StartVideoResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body StartZappitiServiceRequest (required)
Body Parameter —

Return type

StartZappitiServiceResult

Example data

Content-Type: application/json
{
  "ErrorCode" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

StartZappitiServiceResult

Models

[ Jump to Methods ]

Table of Contents

  1. Button -
  2. ButtonType -
  3. CheckZappitiServiceRequest -
  4. CheckZappitiServiceResult -
  5. ConnectionDetailsRequest -
  6. ConnectionDetailsResult -
  7. ErrorCode -
  8. InstallZappitiServiceRequest -
  9. InstallZappitiServiceResult -
  10. IsAliveRequest -
  11. IsAliveResult -
  12. IsPlayingRequest -
  13. IsPlayingResult -
  14. LastMediaRequest -
  15. LastMediaResult -
  16. LaunchAppRequest -
  17. LaunchAppResult -
  18. Media -
  19. MediaRequest -
  20. MediaResult -
  21. MediaType -
  22. Menu -
  23. MenuRequest -
  24. MenuResult -
  25. MenuType -
  26. PictureTypeEnum -
  27. SeenState -
  28. StartVideoRequest -
  29. StartVideoResult -
  30. StartZappitiServiceRequest -
  31. StartZappitiServiceResult -
  32. TechnicalInfo -

Button - Up

Id
UUID format: uuid
Image
String format: string
Type
ButtonType
Text
String format: string

ButtonType - Up

CheckZappitiServiceRequest - Up

Check if Zappiti Service app status on the player
ApiKey
UUID format: uuid

CheckZappitiServiceResult - Up

ErrorCode
ErrorCode

ConnectionDetailsRequest - Up

Get user's login details
ApiKey
UUID format: uuid

ConnectionDetailsResult - Up

AuthKey
UUID format: uuid
Collection
String format: string
ServerIp
String format: string
ServerPort
Integer format: int32
Email
String format: string
ErrorCode
ErrorCode

ErrorCode - Up

InstallZappitiServiceRequest - Up

Open a popup that allow the user to install Zappiti Service, if not already installed
ApiKey
UUID format: uuid

InstallZappitiServiceResult - Up

ErrorCode
ErrorCode

IsAliveRequest - Up

Get server status
ApiKey
UUID format: uuid

IsAliveResult - Up

ErrorCode
ErrorCode

IsPlayingRequest - Up

ApiKey
UUID format: uuid

IsPlayingResult - Up

IsPlaying
Boolean
ErrorCode
ErrorCode

LastMediaRequest - Up

Get informations about last media playback
ApiKey
UUID format: uuid

LastMediaResult - Up

ErrorCode
ErrorCode
Media
Media

LaunchAppRequest - Up

ApiKey
UUID format: uuid
ApplicationName
String format: string

LaunchAppResult - Up

ErrorCode
ErrorCode

Media - Up

Id
UUID format: uuid
Title
String format: string
PosterUrl
String format: string
BackgroundUrl
String format: string
Type
MediaType
SeenState
SeenState
AllowedForChildren
Boolean
Episode
Integer format: int32
Season
Integer format: int32
TvShowName
String format: string
Synopsis
String format: string
Rating100
Integer format: int32
Aired (optional)
Long format: int64
Actors
array[String] format: string
Directors
array[String] format: string
TechnicalInfo
TechnicalInfo

MediaRequest - Up

Request media details for the current Zappiti Collection
ApiKey
UUID format: uuid
Id
UUID format: uuid

MediaResult - Up

ErrorCode
ErrorCode
Media
Media

MediaType - Up

Menu - Up

Id
UUID format: uuid
Buttons
array[Button]

MenuRequest - Up

Request the content of a menu for the current Zappiti Collection
ApiKey
UUID format: uuid
Id
UUID format: uuid
Type
MenuType

MenuResult - Up

ErrorCode
ErrorCode
Menu
Menu

MenuType - Up

PictureTypeEnum - Up

SeenState - Up

StartVideoRequest - Up

Start the playback
ApiKey
UUID format: uuid
MediaId
UUID format: uuid

StartVideoResult - Up

ErrorCode
ErrorCode

StartZappitiServiceRequest - Up

Start Zappiti Service if not started yet
ApiKey
UUID format: uuid

StartZappitiServiceResult - Up

ErrorCode
ErrorCode

TechnicalInfo - Up

Container
String format: string
VideoAspectRatio
String format: string
VideoDefinition
String format: string
VideoCodec
String format: string
VideoFramerate
String format: string
AudioChannels
String format: string
AudioCodec
String format: string
AudioLanguages
String format: string
Subtitles
String format: string
Runtime
Integer format: int32
AudioFormatProfile
String format: string