Introduction

This page serves as a central guide to the documentation.

Are you using our white-label client? We recommend that you do; It takes care of caching and authentication, and is designed to make your life easier.

Please familiarize yourself with our API guidelines for app development which lay out guidelines for clients interactions with the server.

API versions

AminoTV has two styles of API:

Legacy API - documented here
REST based - documented here

We maintain a list of endpoints that are in live service on our page about the AminoTV API Lifecycle

We recommend that you only use the currently supported versions of an endpoint. Endpoints that are deprecated are frozen and will not receive feature updates.

Obtain a copy of our SDK

Amino provides a javascript client SDK that will accelerate your development process. An android SDK is in development; We do not currently have an iOS native SDK.

We can't link to it directly from here because this SDK is not publicly published and using it is subject to business agreements being in place.

Please contact your account representative for a copy.

Quickstart

Authenticate a user and obtain a cookie

Take a look at our page about Authentication.

Logging in

sdk.user.login('me@example.com', '12345678')
  .then(() => {
    // Login successful
  })
  .catch(error => {
    // Login failed
  });

Find the service name

This should have been communicated to you by your account manager at Amino

Make a call to the client API

curl 'https://customer.domain/api/epg?service=betaserver&st=1549288800&et=1549375200&sort=rec_count__desc&ipp=10&ch=1,2,3,4,5,6,7,8,9,10,11,27,12,3036,14,15,74,51,53,52,17,13,19,33,3006,28,29,30,16,3003,26,47,20,21,25,24,23,31,32,34,35,36,37,38,39,40,41,42,44,3009,3007,45,3010,18,49,50&service=service_name&_=1549291338147' -H 'Accept: application/json, text/javascript, */*; q=0.01' -H 'Accept-Language: en-GB,en;q=0.5' --compressed -H 'Connection: keep-alive' -H 'Cookie: PHPSESSID=123; ssid=123; SimpleSAMLSessionID=123; SimpleSAMLAuthToken=123; username=user@customer.domain; usid=123; SamlAuthenticated=1'

Fetch the electronic programme guide

We have an in-depth guide available here.

Definition: A BroadcastSlot is a time period on a Channel in which a Program may be shown. We store information about the time slot as well as a title for the slot.

As a quick start you should be able to build the EPG using just the BroadcastSlot information. We include enough information about the Program for you to show the title and a thumbnail for each slot.

The call you need to make is to GET /api/metadata/v1/broadcast_slots

You'll notice that none of the channel information is included in the broadcast slot output. To get channel names and logos you should call the Channel API (see the advice for that API).

Play some content

Please see /wiki/spaces/MAPI/pages/49676718

AminoTV API - Getting started