Aperçu: Social Syndication API

Messages d'erreur

Si une demande d'API échoue, un message d'erreur sera renvoyé. Les réponses d'erreur ressembleront à ceci:

  [
    {
      "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

Endpoint: /accounts/{account_id}/mrss/syndications

Exemple de corps de demande:

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

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}

Exemple de corps de demande:

  {
    "name": "my new name"
  }

Notez que le corps de la demande pour les demandes PATCH doit ne sont pas inclure les champs (type, id et syndication_url).

Supprimer une syndication

Méthode: DELETE

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}

Obtenez toutes les syndications pour un compte

Méthode: GET

Endpoint: /accounts/{account_id}/mrss/syndications

Obtenez une syndication spécifique

Méthode: GET

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}

Définir le modèle pour une syndication universelle

Méthode: PUT

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Exemple de corps de demande:

  <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

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Obtenez le flux associé à une syndication

L'URL du flux peut être obtenue auprès de la syndication syndication_url terrain, 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

Endpoint: /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

Propriétés de premier niveau

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

Video Cloud identifiant de compte

• account_id

VideoCloud par défaut player préfixe d'URL de la page

Utilisez comme ceci:

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

• player_url

URL de la page suivante du flux

• next_page

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

• assets

Propriétés des actifs

Les ressources de la collection d'actifs 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 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 celles renvoyées dans le sources)
• hls_source (retourne la source HLS - sera vide s'il n'en existe 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é extraites pour la vidéo. Les valeurs autorisées sont "SD", "HD", "FHD" et "UHD".)

Propriétés source

Les ressources de la collection de sources d'un actif 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

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

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

Propriétés de rendu dynamique

La 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 à Liquid

filtre toUTC

Nous avons étendu notre analyseur liquide pour prendre en charge un filtre toUTC qui analysera la plupart des formats de chaîne de date / heure ISO-8601 et les transformera en chaînes de date / heure 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></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>

filtre toEpoch

L'analyseur liquide 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 des 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 pour l'entrée dans les filtres mathématiques. Par exemple:

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

produit une sortie comme celle-ci:

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

Filtre d'Epoch

Le filtre fromEpoch convertit les nombres représentant les millisecondes depuis l'époque en chaînes de date UTC. Le filtre accepte é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 un reformatage si nécessaire.

Exemple :

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

produit une sortie comme celle-ci:

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