Device Management API for User Portals

Part of Ooyala Player API family, these APIs can be called from either the client application itself or from a user self-service portal portal, and forms.

Note: The endpoint for these calls is player.ooyala.com.

Get Reason for Registration Failure

Use this request to get a fuller explanation of why the license request might have failed.

Note: The auth_token returned in the failed registration response must be used to get the last result. The response applies only to the playback session associated with the supplied auth_token.

Device registration is tied to the issuing of the license by the DRM client, because it is the DRM client that supplies the required device ID. Unfortunately, if a license request fails, an Ooyala-specific error response cannot be returned because the DRM clients require a response in a particular, non-Ooyala format.

Therefore, use this GET request to obtain more detailed information about a possible licensing/registration failure.

This request returns error messages if either the device limit or the entitlement limit is reached, in addition to other error conditions. The request also returns a list of previously registered devices, so the user can determine if they are correct.

[GET]player.ooyala.com/sas/api/v1/device_management/auth_token/auth_token/last_result

Example Response

{  
   "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:23.0) Gecko/20100101 Firefox/23.0",
   "registration_time":"2013-09-09 12:41:40 -0700",
   "result":"device binding failed",
   "public_device_id":null,
   
   "devices":[  
      {  
         "public_device_id":"aadf73a0-54ec-424d-9666-c70d17bc8f8b",
         "nickname":null,
         "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:23.0) Gecko/20100101 Firefox/23.0"
      }
   ]
}
  • 200 result : Either success or a specific error message about why the registration failed. The following are possible results:
    • new device registered
    • device binding failed. This message is returned if the entitlement-level device limit has been reached. The devices array contains only the device IDs that are already bound to the entitlement.
    • no device registration action
    • device limit reached
  • 404 device registration last result not found

Get List of Registered Devices for a viewer

[GET]player.ooyala.com/sas/api/v1/device_management/auth_token/auth_token/devices

Response

The array devices includes the following fields for each device registered with the viewer.

{  
   “device_limit”:“maximum number of devices allowed”,
   “next_delete_time”:“The time at which the device can be deleted (ISO 8601)”,
   “devices”:[  
      {  
          "public_device_id":“sample_device_id”,
            "user_agent":”sample_user_agent”,
            "registration_time":“time at which registered (ISO 8601)”,
            "nickname":“device_nickname”
      },
      . 
      . 
      .
   ]
}

Update a device’s nickname

[PUT]player.ooyala.com/sas/api/v1/device_management/auth_token/auth_token/devices/public_device_id{
   "nickname":"someNickname"
}

Responses

200 {"message": "OK"} - Request succeeded.

404 {"message": "Device Not Found"} - Returned if device with the given public_device_id was not found.

403 {"message": "Invalid Token"} - Returned if the auth_token was invalid.

Delete Devices

This is checked against the provider's deletion limits.

[DELETE]player.ooyala.com/sas/api/v1/device_management/auth_token/auth_token/devices/public_device_id

Responses

200 {"message": "OK"} - Request succeeded.

404 {"message": "Device Not Found"} - Returned if device with the given public_device_id was not found.

403 {"message": "Invalid Token"} - Returned if the auth_token was invalid.

429 {"message": "Delete Limit Reached"} - Returned if deletion was not allowed because of recent attempts

해당 내용이 도움 되었습니까?