Introduction
Des dossiers peuvent être créés pour organiser les vidéos dans votre vidéothèque. Vous pouvez choisir d'organiser les vidéos par sujet, auteur, produit, région, etc. Avoir des vidéos dans des dossiers les rend plus faciles à gérer dans un compte avec des centaines ou des milliers de vidéos.
Obtenir des informations d'identification pour l'API CMS
Pour utiliser le CMS API vous aurez besoin des informations d'identification appropriées.
Dans la plupart des cas, le moyen le plus simple d'obtenir des informations d'identification consiste à utiliser la section Authentification de l'API Studio Admin (nécessite des autorisations d'administrateur sur votre compte). Voir Gestion des informations d'identification d'authentification API pour plus de détails. Dans ce cas, les autorisations dont vous avez besoin sont pour vidéos - vous avez besoin à la fois des autorisations de lecture et d'écriture :
Si les autorisations dont vous avez besoin ne sont pas disponibles dans Studio, ou si vous préférez les obtenir directement à partir de l'API OAuth, utilisez votre choix de Obtenir les informations d'identification du client documents énumérés ci-dessous. Quelle que soit l'option que vous choisissez, vous devrez demander les autorisations d'opération correctes. Les éléments suivants peuvent être utilisés avec cURL ou Postman pour obtenir les autorisations appropriées :
"operations": [
"video-cloud/videos/read",
"video-cloud/videos/create",
"video-cloud/videos/update"]
Création de dossiers
Voici les informations dont vous avez besoin pour créer un nouveau dossier.
URL de demande
Faire un POST demande à:
https://cms.api.brightcove.com/v1/accounts/account_id/folders
Corps de la demande
{
"name": folder_name
}
Réponse
La réponse ressemblera à ceci :
{
"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
}
Le dossier id et name (le nom que vous avez défini dans le corps de la requête) sont importants, car vous aurez besoin des deux pour ajouter une vidéo au dossier. Ne vous inquiétez pas si vous oubliez le id , cependant, parce que vous pouvez toujours obtenir à nouveau ces informations en obtenir les dossiers pour le compte.
Obtenir des dossiers
Pour obtenir un tableau des dossiers d'un compte, il suffit de faire un GET demande à:
https://cms.api.brightcove.com/v1/accounts/account_id/folders
La réponse ressemblera à ceci :
[
{
"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
}
]
Ajouter une vidéo au dossier
Pour ajouter une vidéo à un dossier, faites un PUT demande à:
https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id
Corps de la demande
Il n'y a pas de corps de requête pour cette opération.
Réponse
La réponse à cette demande sera 204 NO CONTENT.
Supprimer la vidéo du dossier
Pour supprimer une vidéo d'un dossier, faites un DELETE demande à la même URL que vous utilisez pour ajouter une vidéo :
https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id
Corps de la demande
Pour cette demande, vous devez également inclure le nom du dossier dans le corps de la demande :
{
"name": folder_name
}
Obtenir des vidéos dans un dossier
Pour obtenir les vidéos dans un dossier, faites un GET demande à:
https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos
Paramètres de requête
limit et offset
Par défaut, cette requête renvoie les 20 vidéos les plus récemment ajoutées au dossier. Vous pouvez modifier cela et parcourir les résultats d'un dossier contenant de nombreuses vidéos, en ajoutant un ou les deux paramètres à la demande :
limit: le nombre de vidéos à renvoyer (par défaut : 20 ; maximum : 100)offset: le nombre de vidéos à ignorer (par défaut : 0)
Par exemple, cette requête renverra les vidéos 21 à 30 des résultats possibles (en supposant que le dossier contienne autant de vidéos) :
https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos?limit=10&offset=20sort
Vous pouvez également trier les vidéos renvoyées en utilisant le sort paramètre, en le définissant égal à l'un de ces champs:
- nom
- Pièce d'identité
- updated_at
- created_at
- published_at
- schedule_starts_at
- schedule_ends_at
- État
- lectures_total
- play_trailing_week
Pour trier par ordre décroissant, faites précéder la valeur du champ d'un sige (-created_at) négatif.
La valeur par défaut pour sort est -updated_at.