Admin APIs
At its core, SyncTV is an API driven service. The APIs themselves are easy enough for developers to understand, but understanding the ecosystem is a little trickier. We've created the following tutorials to help you get your head around it.

Topics:

  • Platforms

This document describes the API for platforms. Platforms have two states for status:

0 - inactive
1 - active
Note:
Each call to the SyncTV V2 API described in this section requires an MD5 hash signature.
See the Authorization (User) API for details on generating the MD5 hash signature.
Actions

Url:

  • [GET] /api/v2/platforms.[xml|json]

Returns a list of all platforms.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

The following example returns all platforms for the service.
[GET] https://service_name.synctv.com/api/v2/platforms.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Integer) offset — Used for pagination of response data (default: 25 items per response). Specifies the offset of the next block of data to receive.
  • (String) status — Filters response based on value of status field.
Example Response
XML JSON

<response>
  <platforms>
    <platform>
      <id>1</id>
      <name>platform_1</name>
      <status>1</status>
      <version>1.0</version>
      <allow_clear_content nil="true"/>
      <client_ids/>
      <uid>49211693</uid>
      <platform_type nil="true"/>
      <cap>true</cap>
    </platform>
    <platform>
      <id>2</id>
      <name>platform_2</name>
      <status>1</status>
      <version>1.0</version>
      <allow_clear_content nil="true"/>
      <client_ids/>
      <uid>43598639</uid>
      <platform_type nil="true"/>
      <cap>true</cap>
    </platform>
  </platforms>
</response>
Response Fields:
  • (Response) platforms
    A list of platforms. See below for a description of the platform response fields.

Url:

  • [GET] /api/v2/platforms/:id.[xml|json]

Returns the specified platform.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of query parameters.
Example Request

The following example returns information for platform 100.
[GET] https://service_name.synctv.com/api/v2/platforms/100.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <platform>
    <id>100</id>
    <name>platform_3</name>
    <status>1</status>
    <version>1.0</version>
    <allow_clear_content nil="true"/>
    <client_ids/>
    <uid>34217103</uid>
    <platform_type nil="true"/>
    <cap>true</cap>
  </platform>
</response>
Response Fields:
  • (Integer) platform[id]
    The platform's unique identifier.
  • (String) platform[name]
    The platform's name.
  • (String) platform[version]
    The version of the platform.
  • (String) platform[uid]
    The UID of the platform.
  • (Boolean) platform[status]
    Platform status.
  • (Boolean) platform[allow_clear_content]
    Indicates if clear (non-protected) content is allowed for the platform.
  • (Array) client_ids
    List of all client_ids associated with the platform.
  • (Integer) platform[platform_type][id]
    The id of the platform's associated platform_type.
  • (String) platform[platform_type][name]
    The name of the associated platform_type.