Exemple de requête utilisant Curl

Voici des exemples de demandes adressées à l'API Broadsign Air.

Copier 
curl -X POST \
  https://air.broadsign.com/playlist/v1/generate \        
  -H 'Authorization: Bearer cbdbc369a063de6c0f458557f1456602' \        
  -d '{    
  "player_identifier": "abcd1234",    
  "screen_identifier": "1",    
  "duration": "3600s"
  }'

 

Paramètre Description
Verbe HTTP L'API utilise le verbe HTTP POST pour générer une liste de lecture pour les paramètres spécifiés.
URL

Le nom d'hôte que fournit Broadsign.

Dans notre exemple, le point de terminaison que nous souhaitons utiliser est playlist/v1/generate. Cette requête générera des listes de lecture côté serveur sur notre domaine. Pour une liste complète de toutes les ressources, voir Points de terminaison de l'API Broadsign Air.
Autorisation Broadsign accepte un jeton d'authentification HTTP inclus dans l'en-tête « Authorization » des requêtes HTTPS à l'API REST, comme défini dans la RFC 7235.
player_identifier Identifiant Broadsign Control Player unique, censé représenter un lieu unique.
screen_identifier

Identifie de manière unique les écrans individuels d'un lieu qui sont connectés au même Broadsign Control Player. C'est une valeur opaque fournie par le client.

Le screen_identifier permet de suivre avec précision le nombre d'écrans qui ont confirmé la lecture du contenu, ce qui est crucial pour fournir une preuve de lecture précise dans Broadsign Air.

Conseil : L'utilisation d'identifiants d'écran clairs et cohérents est essentielle pour générer des rapports de preuve de diffusion précis dans Broadsign Air.

Le même screen_identifier (par exemple, « screen-00 », « screen-01 ») peut être utilisé dans plusieurs lieux, c'est-à-dire qu'il peut être réutilisé dans différents player_identifiers.

Ce champ n'est pas obligatoire mais est fortement recommandé pour un suivi précis de la lecture.

Pour plus d'informations, voir Signaler les POP des lecteurs avec Broadsign Air.
duration Voir generate et pour plus de détails.

Copier 
curl -X POST \
  https://air.broadsign.com/playlist/v2/generate_long \        
  -H 'Authorization: Bearer cbdbc369a063de6c0f458557f1456602' \        
  -d '{    
  "player_identifier": "abcd1234",    
  "screen_identifier": "1",    
  "date": {
    "year": 2022,
    "month": 8,
    "day": 29
   }
  }'

 

Paramètre Description
Verbe HTTP L'API utilise le verbe HTTP POST pour générer une liste de lecture pour les paramètres spécifiés.
URL

Le nom d'hôte que fournit Broadsign.

Dans notre exemple, le point de terminaison que nous souhaitons utiliser est playlist/v2/generate_long. Cette requête générera des listes de lecture côté serveur sur notre domaine. Pour une liste complète de toutes les ressources, voir Points de terminaison de l'API Broadsign Air.
Autorisation Broadsign accepte un jeton d'authentification HTTP inclus dans l'en-tête « Authorization » des requêtes HTTPS à l'API REST, comme défini dans la RFC 7235.
player_identifier Identifiant Broadsign Control Player unique, censé représenter un lieu unique.
screen_identifier Identifiant d'un écran au sein d'un lieu.

Cela peut être omis. Il s'agit d'une valeur opaque fournie par le client qui identifie les lecteurs physiques dans un lieu rattaché au même Broadsign Control Player. Ils peuvent être réutilisés dans différents player_identifier.

Par exemple : plusieurs lieux peuvent avoir les mêmes identifiants screen_identifiers tels que screen-00 et screen-01. Ils sont utilisés pour suivre correctement le nombre d'écrans ayant confirmé la lecture des éléments afin que Broadsign Air puisse fournir des preuves précises des diffusions.
date Voir generate_long pour plus de détails.