Player Management API (Deprecated)

The Player Management API allows for the listing of available players and the assignment of a player to particular embed code(s).

Note: This software is deprecated. Use the latest version.

There are two modes, 'list' and 'assign'. As in the Query API, interaction with the Player Management API is through signed REST-style requests to http://api.ooyala.com/partner/players.

Required Parameters

  • pcode – Provider Code
  • expires – Query expiration time in seconds since epoch (00:00:00 1/1/1970 GMT)
  • mode – One of list or assign
  • signature – The digital signature of the request. The signature should be calculated using SHA-256 with the signature generation rules.

List Mode

List all avilable players. No additional parameters required.

Example:

http://www.ooyala.com/partner/players?pcode=<pcode>&expires=<expiration>&mode=list&signature=<signature>

Result:

<?xml version="1.0" encoding="UTF-8"?>
<players size=1>
  <player>
    <pid>e870d9c7-cd69-4b56-b8fd-3cf10a83cf12</pid>
    <name>Default Player</name>
  </player>
</players>

Assign Mode

Additional required parameters: embedCodes, pid

Assigns a comma-separated list of video embed codes (or a single embed code) to a particular player. An existing player will be overwritten when using this mode. Returns a text file with 'OK' on success or an error message on failure.

Example:


http://ooyala.com/partner/players?mode=assign&pcode=<pcode>&expires=<expiration>&embedCodes=9kaTUyOk20sGc8NM9ITgxkRWYlty68d4&pid=e870d9c7-cd69-4b56-b8fd-3cf10a83cf12&signature=<signature>

Was this article helpful?