Error message

User warning: The following module is missing from the file system: fast_404. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1143 of /mnt/www/html/ooyala/docroot/includes/bootstrap.inc).

API de gestión de etiquetas

La API de gestión de etiquetas permite el control programático de etiquetas. En la API se incluyen las órdenes de creación y eliminación de etiquetas, asociación y borrado de etiquetas y contenido y renombramiento de una etiqueta.

Al igual que en el ejemplo de la API de consultas, la interacción con la API de Etiquetas de Backlot se realiza mediante consultas tipo REST firmadas a http://api.ooyala.com/partner/labels.

Las respuestas serán XML y seguirán la estructura siguiente

<?xml version="1.0" encoding="UTF-8"?>
<result code="success">ok</result>

El código será uno entre success (error), failure (fallo), params_missing (falta de parámetros). La respuesta en xml del <result> será "ok" si es exitosa o una explicación del error si es un fallo.

Parámetros necesarios

  • pcode – Código del proveedor
  • expires – Expiración de la consulta en segundos desde epoch (00:00:00 1/1/1970 GMT)
  • mode – Uno entre listLabels, createLabels, deleteLabels, assignLabels, unassignLabels, renameLabel, o clearLabels
  • signature – La firma digital de la consulta. La firma debe calcularse usando SHA-256 según las reglas de generación de firmas.

listLabels

Devuelve una lista de etiquetas de la cuenta dada.

Parámetros opcionales: label - Si se ha proporcionado, se devuelven las subetiquetas de la etiqueta especificada. Si no se proporciona, se devuelven todas las etiquetas de la cuenta.

Ejemplo:

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

createLabels y deleteLabels

Parámetro adicional obligatorio: una lista de etiquetas separadas por comas o una lista de parámetros label[<id>]=label

createLabels y deleteLabels permiten la creación y eliminación de etiquetas, respectivamente. Las etiquetas deben comenzar con una barra '/' y puede especificarse una estructura de árbol de la manera normal: /abuelo/padre/hijo. Las etiquetas pueden especificarse en uno de dos formatos:

  1. labels=<label1>,<label2>,<label3>
  2. label[1]=<label1>&label[2]=<label2>&label[3]=<label3>

En el caso de rutas de etiquetas con varios elementos como /labelParent/labelChild, la ruta completa será creada incluyendo las etiquetas padre, como sea necesario.

Ejemplos:

http://api.ooyala.com/partner/labels?pcode=<pcode>&expires=<expiration>&labels=/hello&
mode=createLabels&signature=<signature>

http://api.ooyala.com/partner/labels?pcode=<pcode>&expires=<expiration>&labels=/hello&mode=
deleteLabels&signature=<signature>

assignLabels y unassignLabels

Parámetros adicionales obligatorios: embedCodes, etiquetas (o label[<id>])

Parámetros opcionales:

  • includeSublabels=true

    Para unassignLabels, elimine las etiquetas inferiores de la ruta. Por ejemplo, si ha asociado contenido con las etiquetas/padre y padre/hijo y elimina /padre, /padre/hijo se eliminará también. La opción por defecto es false.

  • ignoreNotFound=true

    Para unassignLabels, fuerza un resultado de éxito ("OK") si la etiqueta especificada no está presente. La opción por defecto es false.

  • createLabels=false

    Para assignLabels, no crea la etiqueta si no existe. La opción por defecto es true.

assignLabels y unassignLabels permite la asignación o eliminación de etiquetas, respectivamente, con un conjunto de vídeos. Las etiquetas pueden especificarse de igual manera que se hizo anteriormente. Los vídeos están especificados con una lista de códigos embebidos separados por comas.

Ejemplos:

http://api.ooyala.com/partner/labels?pcode=<pcode>&embedCodes=<embedCode1>,<embedCode2>
&expires=<expiration>&labels=/hello,/bye&mode=assignLabels&signature=<signature>

http://api.ooyala.com/partner/labels?pcode=<pcode>&embedCodes=<embedCode1>,<embedCode2>
&expires=<expiration>&labels=/hello,/bye&mode=unassignLabels&signature=<signature>

renameLabel

Parámetros adicionales obligatorios: oldlabel, newlabel

renameLabel le permite renombrar o mover una etiqueta sin perder sus vídeos asociados. Si newlabel tiene antecedentes diferentes a oldlabel, se moverá de manera consecuente. Si el nombre es diferente, será renombrado de manera apropiada.

Ejemplo:

http://api.ooyala.com/partner/labels?pcode=<pcode>&embedCodes=<embedCode1>,<embedCode2>
&expires=<expiration>&mode=renameLabel&newlabel=/bye&oldlabel=/hello&signature=<signature>

clearLabels

Parámetro adicional necesario: embedCodes

clearLabels permite la eliminación de todas las etiquetas asociadas de un conjunto de vídeos que enumera las etiquetas individualmente. Los vídeos están especificados con una lista de embedCodesseparada por comas con los modos assignLabels y unassignLabels.

Ejemplo:

http://api.ooyala.com/partner/labels?pcode=<pcode>&embedCodes=<embedCode1>&
expires=<expiration>&mode=clearLabels&signature=<signature>