Présentation : API de syndication sociale

Messages d’erreur

Si une demande d'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 de terminaison : /accounts/{account_id}/mrss/syndications

Corps de demande d'échantillon :

  {
    "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 de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}

Corps de demande d'échantillon :

  {
    "name": "my new name"
  }

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

Supprimer une syndication

Méthode : DELETE

Point de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}

Obtenir toutes les syndications pour un compte

Méthode : GET

Point de terminaison : /accounts/{account_id}/mrss/syndications

Obtenir une syndication spécifique

Méthode : GET

Point de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}

Définir le modèle pour une syndication universelle

Méthode : PUT

Point de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Corps de demande d'échantillon :

  <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>

Obtenir le modèle pour une syndication universelle

Méthode : GET

Point de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Récupère le flux associé à une syndication

L'URL du flux peut être obtenue à partir du syndication_url champ de la syndication, ou construite manuellement. Notez que l' API de flux de syndication peut également être utilisée pour récupérer un flux sans authentification.

Méthode : GET

Point de terminaison : /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

Propriétés de niveau supérieur

Dérivé des champs Syndication

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

ID de compte Video Cloud

• account_id

Préfixe d'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

Collecte des ressources vidéo extraites du catalogue (voir ci-dessous pour plus de détails)

• assets

Propriétés de l'actif

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

• 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'actifs 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 maître numérique n'existe - voir ci-dessous pour les propriétés du maître numérique)
• best_mp4_source ( 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 articles retournés dans le sources)
• hls_source ( retourne la source HLS - sera vide si aucune n'existe)
• best_dynamic_rendition_quality ( renvoie la qualité vidéo du rendu dynamique de la vidéo avec la taille d'image la plus élevée, 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 actif sont dérivées des ressources source vidéo renvoyées par la méthode CMS Get Video Sources API. 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 maîtresses numériques

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

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

Propriétés du format associé dynamique

La dynamic_renditions ressource d'une ressource est dérivée des formats associés dynamiques renvoyés par la méthode CMS Get Digital Master Info API. 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 à Liquid

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 UTC datetime 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></pubDate>

Cela produit une sortie comme suivante si asset.published_at a une valeur de 2019-08-09T 13:32:52 .031Z።

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

Filtre ToEpoch

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 epoch. Le filtre renvoie une valeur de données numérique représentant des millisecondes depuis l'époque qui convient à l'entrée dans les filtres mathématiques. Par exemple :

  <toEpochMillis>now</toEpochMillis>
  <toEpochSeconds>0</toEpochSeconds>
  <thirtyDaysAgo>-2592000000</thirtyDaysAgo>

produit une sortie comme suit :

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

Filtre FromEPoch

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

Par exemple :

  
  <fromEpochMillis>now</fromEpochMillis>
  <thirtyDaysAgoAltFormat>52067-04-10</thirtyDaysAgo>
  

produit une sortie comme suit :

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