Introducción
Se pueden crear carpetas para organizar videos en su biblioteca de videos. Puede optar por organizar los videos por tema, autor, producto, región, etc. Tener videos en carpetas hace que sean más fáciles de administrar en una cuenta con cientos o miles de videos.
Obtenga credenciales para la API de CMS
Usar el CMS API necesitará las credenciales adecuadas.
La forma más sencilla de obtener credenciales en la mayoría de los casos es a través de la sección Autenticación de API de administración de Studio (requiere permisos de administrador en tu cuenta). Consulte Administración de credenciales de autenticación de API para obtener más información. En este caso, los permisos que necesita son para videos - necesita permisos de lectura y escritura:
Si los permisos que necesita no están disponibles en Studio, o si prefiere obtenerlos directamente de la API de OAuth, utilice su elección de Obtener credenciales de cliente documentos que se enumeran a continuación. Sea cual sea la opción que elija, tendrá que solicitar los permisos de operación correctos. Lo siguiente se puede usar con cURL o Postman para obtener los permisos adecuados:
"operations": [
"video-cloud/videos/read",
"video-cloud/videos/create",
"video-cloud/videos/update"]
Creando carpetas
Aquí está la información que necesita para crear una nueva carpeta.
Solicitar URL
Hacer una POST solicitud de:
https://cms.api.brightcove.com/v1/accounts/account_id/folders
Cuerpo de la solicitud
{
"name": folder_name
}
Respuesta
La respuesta se verá así:
{
"id": "5a183efb10ab344b53775441",
"account_id": "57838016001",
"created_at": "2017-11-24T15:47:07.867Z",
"name": "places",
"updated_at": "2017-11-24T15:47:07.867Z",
"video_count": 0
}
La carpeta id y name (el nombre que establezca en el cuerpo de la solicitud) son importantes, ya que necesitará ambos para agregar un video a la carpeta. No te preocupes si olvidas el id , sin embargo, porque siempre puede obtener esta información de nuevo conseguir las carpetas por la cuenta
Obtener carpetas
Para obtener una matriz de carpetas para una cuenta, simplemente haga un GET solicitud de:
https://cms.api.brightcove.com/v1/accounts/account_id/folders
La respuesta se verá así:
[
{
"id": "5a17275782aca45b631295f9",
"account_id": "57838016001",
"created_at": "2017-11-23T19:53:59.687Z",
"name": "birds",
"updated_at": "2017-11-23T20:06:24.537Z",
"video_count": 1
},
{
"id": "560039e5e4b0e69e4b01cacd",
"account_id": "57838016001",
"created_at": "2015-09-21T17:09:57.260Z",
"name": "fish",
"updated_at": "2017-11-02T19:03:40.751Z",
"video_count": 4
},
{
"id": "5a183efb10ab344b53775441",
"account_id": "57838016001",
"created_at": "2017-11-24T15:47:07.867Z",
"name": "places",
"updated_at": "2017-11-24T15:47:07.867Z",
"video_count": 0
},
{
"id": "560039f1e4b0e69e4b01cad3",
"account_id": "57838016001",
"created_at": "2015-09-21T17:10:09.422Z",
"name": "water",
"updated_at": "2015-09-21T17:22:52.935Z",
"video_count": 7
}
]
Agregar video a la carpeta
Para agregar un video a una carpeta, haga un PUT solicitud de:
https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id
Cuerpo de la solicitud
No hay un cuerpo de solicitud para esta operación.
Respuesta
La respuesta a esta solicitud será 204 NO CONTENT.
Eliminar video de la carpeta
Para eliminar un video de una carpeta, haga un DELETE solicitud a la misma URL que usa para agregar un video:
https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id
Cuerpo de la solicitud
Para esta solicitud, también debe incluir el nombre de la carpeta en el cuerpo de la solicitud:
{
"name": folder_name
}
Obtener videos en una carpeta
Para obtener los videos en una carpeta, haga una GET solicitud de:
https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos
Solicitar parámetros
limit y offset
De forma predeterminada, esta solicitud devuelve los 20 videos agregados más recientemente a la carpeta. Puede cambiar esto y recorrer los resultados de una carpeta que contiene muchos videos, agregando uno o ambos de estos parámetros a la solicitud:
limit: la cantidad de videos que se devolverán (predeterminado: 20; máximo: 100)offset: la cantidad de videos que se van a omitir (predeterminado: 0)
Por ejemplo, esta solicitud devolverá videos del 21 al 30 de los posibles resultados (asumiendo que la carpeta contiene tantos videos):
https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos?limit=10&offset=20sort
También puede ordenar los videos que se devuelven utilizando el sort parámetro, configurándolo igual a cualquiera de estos campos:
- nombre
- reference_id
- updated_at
- created_at
- publicado_en
- schedule_starts_at
- schedule_ends_at
- estado
- plays_total
- plays_trailing_week
Para ordenar en orden descendente, anteponga el valor del campo con un signo menos (-created_at).
El valor predeterminado para sort es -updated_at.