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:

  • Contributors

This document describes the API for creating, reading, updating and deleting contributors.

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/contributors.[xml|json]
  • [GET] /api/v2/media/:medium_id/contributors.[xml|json]

Returns a list of all contributors.

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 request returns a list of all contributors.
[GET] https://service_name.synctv.com/api/v2/contributors.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.
Example Response
XML JSON

<response>
  <contributors>
    <contributor>
      <id>1</id>
      <media_id>1</media_id>
      <program_id nil="true"/>
      <person>person name 7</person>
      <role>role 7</role>
    </contributor>
    <contributor>
      <id>2</id>
      <media_id>2</media_id>
      <program_id nil="true"/>
      <person>person name 8</person>
      <role>role 8</role>
    </contributor>
    <contributor>
      <id>3</id>
      <media_id>3</media_id>
      <program_id nil="true"/>
      <person>person name 9</person>
      <role>role 9</role>
    </contributor>
  </contributors>
</response>
Response Fields:
  • (Integer) contributor[id]
    The unique identifier of the contributor.
  • (String) contributor[media_id]
    The media_id associated with this contributor.
  • (String) contributor[person]
    The name of the contributor.
  • (String) contributor[role]
    The role of the contributor.

Url:

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

Returns the specified contributor.

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 the information for contributor 9.
[GET] https://service_name.synctv.com/api/v2/contributors/9.xml?access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Example Response
XML JSON

<response>
  <contributor>
    <id>1</id>
    <media_id>1</media_id>
    <program_id nil="true"/>
    <person>person name 10</person>
    <role>role 10</role>
  </contributor>
</response>
Response Fields:
  • (Integer) contributor[id]
    The unique identifier of the contributor.
  • (String) contributor[media_id]
    The media_id associated with this contributor.
  • (String) contributor[person]
    The name of the contributor.
  • (String) contributor[role]
    The role of the contributor.