Client 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:

  • Configuration

This document describes the API for retrieving Configuration Data.

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/config.[xml|json]

Returns configuration data.

<response>

  <config>
     # this is for all users
     <single_platform>true</single_platform>
  </config>
  <code_>1</code_>
  <message>Successfully completed.</message>
</response>
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 config data.
[GET] https://service_name.synctv.com/api/v2/config.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

Response Fields:
  • (String) s3_cors_sig
    An escaped string containing the necessary URL to the CORS synchtv s3 bucket.
  • (Boolean) single_platform
    True or false on whether single_platform is enabled or disabled.

Url:

  • [GET] /api/v2/config/s3_cors_sig.[xml|json]

Returns s3_cors_sig requried for uploading of data fromc lient directly over to s3.

<response>

  <config>
     # this is for admin users
     <s3_cors_sig>
       <key>subdirectory</key>
       <signature>Oc6cZUzPjuMScKPk4eBk42IBAoc=</signature>
       <policy>eyJleHBpcmF0aW9uIjozMDAsImNvbmRpdGlvbnMiOlt7ImJ1Y2tldCI6Ii9kcml2ZXRocm91Z2gifSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInN1YmRpcmVjdG9yeSJdLHsiYWNsIjoicHVibGljLXJlYWQifSxbInN0YXJ0cy13aXRoIiwiJENvbnRlbnQtVHlwZSIsIiJdXX0=</policy>
     </s3_cors_sig>
  </config>
  <code_>1</code_>
  <message>Successfully completed.</message>
</response>
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 config data.
[GET] https://service_name.synctv.com/api/v2/config.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (String) name — Name of the subdirectory of where you wish to place the data in the s3 bucket.
Example Response
XML JSON

Response Fields:
  • (String) s3_cors_sig
    An escaped string containing the necessary URL to the CORS synchtv s3 bucket.
  • (Boolean) single_platform
    True or false on whether single_platform is enabled or disabled.