Aperçu: API de syndication sociale

Messages d'erreur

Si une requête API échoue, un message d'erreur sera renvoyé. Les réponses d'erreur ressembleront à ce qui suit :

  [
    {
      "error_code" : "Application error code 1",
      "message" : "Application error message 1"
    }, {
      "error_code" : "Application error code 2",
      "message" : "Application error message 2"
    }
  ]

Créer une syndication

Méthode: POST

Point final : /accounts/{account_id}/mrss/syndications

Exemple de corps de requête :

  {
    "name": "my mp4 feed",
    "type": "mp4"
  }

Notez que le name et type les champs sont obligatoires. D'autres sont facultatifs.

Mettre à jour une syndication

Méthode: PATCH

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}

Exemple de corps de requête :

  {
    "name": "my new name"
  }

Notez que le corps de la requête pour les requêtes PATCH doit ne pas inclure les champs (type , id et syndication_url).

Supprimer une syndication

Méthode: DELETE

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}

Obtenez toutes les syndications pour un compte

Méthode: GET

Point final : /accounts/{account_id}/mrss/syndications

Obtenez une syndication spécifique

Méthode: GET

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}

Définir le modèle pour une syndication universelle

Méthode: PUT

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Exemple de corps de requête :

  <feed header>My Feed Header</feed header>
  

Le modèle ci-dessus générerait un flux similaire à :

  <feed header>My Feed Header</feed header>
    <item>
      <title>Title for Video 1</title>
      <video_info>Description for Video 1</video_info>
    </item>
    <item>
      <title>Title for Video 2</title>
      <video_info>Description for Video 2</video_info>
    </item>

Obtenez le modèle pour une syndication universelle

Méthode: GET

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Obtenir le flux associé à une syndication

L'URL du flux peut être obtenue auprès de la syndication syndication_url champ, ou construit manuellement. Notez que le API de flux de syndication peut également être utilisé pour récupérer un flux sans authentification.

Méthode: GET

Point final : /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

Propriétés de niveau supérieur

Dérivé des champs de syndication

• album_art_url
• author
• category
• description
• destination_url
• explicit
• keywords
• name
• owner_name
• owner_email
• subtitle
• syndication_id
• syndication_url
• title

Identifiant de compte Video Cloud

• account_id

Préfixe de l'URL de la page du lecteur par défaut de VideoCloud

Utilisez comme ceci :

  <media:player url="//default_default/index.html?videoId=">

• player_url

URL de la page suivante du flux

• next_page

Collection d'éléments vidéo extraits du catalogue (voir ci-dessous pour plus de détails)

• assets

Propriétés de l'actif

Les ressources de la collection d'éléments sont dérivées des ressources vidéo renvoyées par la méthode d'API CMS Get Videos, et toutes les mêmes propriétés sont prises en charge, y compris, mais sans s'y limiter :

• created_at
• description
• duration
• id
• images
• images.thumbnail
• images.poster
• long_description
• name
• original_filename
• published_at
• schedule
• state
• tags
• text_tracks
• updated_at

Les ressources d'actif prennent également en charge les propriétés suivantes :

• sources(collection de sources pour la vidéo - voir la section suivante pour les propriétés des sources)
• digital_master(sera vide si aucun master numérique n'existe - voir ci-dessous pour les propriétés du master numérique)
• best_mp4_source(la source MP4 de la plus haute qualité - peut être vide s'il n'y a pas de sources MP4. Les propriétés seront les mêmes que les éléments retournés dans le sources)
• hls_source(renvoie la source HLS - sera vide s'il n'y en a pas)
• best_dynamic_rendition_quality(renvoie la qualité vidéo du rendu dynamique de la vidéo avec la plus grande taille d'image, si des métadonnées de rendu dynamique ont été récupérées pour la vidéo. Les valeurs autorisées sont "SD", "HD", "FHD" et "UHD".)

Propriétés de la source

Les ressources de la collection de sources d'un élément sont dérivées des ressources de source vidéo renvoyées par la méthode d'API CMS Get Video Sources. Les propriétés suivantes sont prises en charge :

• app_name
• asset_id
• codec
• container
• created_at
• duration
• encoding_rate
• height
• size
• src
• stream_name
• type
• uploaded_at
• width

Propriétés du maître numérique

Les digital_master La ressource d'un actif est dérivée de la ressource principale numérique renvoyée par la méthode d'API CMS Get Digital Master Info. Les propriétés suivantes sont prises en charge :

• duration
• encoding_rate
• height
• size
• url
• width

Propriétés de rendu dynamique

Les dynamic_renditions La ressource d'un actif est dérivée des rendus dynamiques renvoyés par la méthode de l'API CMS Get Digital Master Info. Les propriétés suivantes sont prises en charge :

• rendition_id
• frame_height
• frame_width
• media_type
• encoding_rate
• created_at
• updated_at
• size
• duration
• audio_configuration
• language
• variant

Extensions au liquide

filtre toUTC

Nous avons étendu notre analyseur Liquid pour prendre en charge un filtre toUTC qui analysera la plupart des formats de chaîne datetime ISO-8601 standard et les transformera en chaînes datetime UTC standard. Ce format est acceptable pour le filtre de date de Liquid, qui peut ensuite être utilisé pour reformater les horodatages en chaînes datetime dans n'importe quel format souhaité. Par exemple :

  <pubDate>{{asset.published_at | toUTC | date: "%a, %d %b %Y %H:%M:%S %Z"}}</pubDate>

Cela produit une sortie comme la suivante si asset.published_at a une valeur de 2019-08-09T13:32:52.031Z ::

  <pubDate>Fri, 09 Aug 2019 09:32:52 +0000</pubDate>

toEpoch filtre

L'analyseur Liquid que nous utilisons ne prend pas en charge le jeton "%s" dans les filtres de date pour convertir les dates en horodatages d'époque Unix. Pour résoudre ce problème, un filtre personnalisé toEpoch est fourni qui peut être utilisé pour convertir les spécifications de date valides au format d'époque. Le filtre renvoie une valeur de données numérique représentant les millisecondes depuis l'époque qui convient à l'entrée dans les filtres mathématiques. Par exemple :

  <toEpochMillis>{{"now" | toEpoch }}</toEpochMillis>
  <toEpochSeconds>{{"now" | toEpoch | divided_by : 1000 }}</toEpochSeconds>
  <thirtyDaysAgo>{{'now' | toEpoch | minus:2592000000 | fromEpoch }}</thirtyDaysAgo>

produit une sortie comme la suivante :

  <toEpochMillis>1580917253024</toEpochMillis>
  <toEpochSeconds>1580917253</toEpochSeconds>
  <thirtyDaysAgo>2020-01-06T15:40:53.055Z</thirtyDaysAgo>

fromEpoch filter

Le filtre fromEpoch convertit les nombres représentant les millisecondes depuis l'époque en chaînes de date UTC. Le filtre acceptera également une chaîne contenant les chiffres de la valeur de l'époque comme entrée. La sortie peut être transmise au filtre de date pour reformatage si nécessaire.

Par exemple :

  
  <fromEpochMillis>{{"now" | toEpoch | fromEpoch }}</fromEpochMillis>
  <thirtyDaysAgoAltFormat>{{1580917253024 | fromEpoch | date:"%Y-%m-%d" }}</thirtyDaysAgo>
  

produit une sortie comme la suivante :

  
  <fromEpochMillis>2020-02-05T16:09:37.809Z</fromEpochMillis>
  <thirtyDaysAgoAltFormat>2020-02-05</thirtyDaysAgo>