API médias : premiers pas avec JavaScript

Product
Video Cloud
S'applique aux utilisateurs
Développeur
Version
Brightcove 5
Modules
API médias
Édition
Tous

Ce document contient les étapes initiales qui permettront de faire vos premiers pas avec l'API médias et les requêtes JavaScript. Ce document suppose que vous connaissez le langage de programmation JavaScript et que vous connaissez les restrictions de sécurité imposées par Flash face aux requêtes HTTP émanant de JavaScript. Voici d'autres éléments à passer en revue avant de continuer :

Meilleures pratiques

L'utilisation de JavaScript pour accéder à l'API médias comporte un certain nombre de risques et d'inconvénients. La sécurité des clés est un élément déterminant. Lorsqu'il accède à votre clé, le pirate accède aussi à votre bibliothèque de contenu et dans certains cas, il peut lire votre contenu à votre insu. Sous JavaScript, votre clé est au format texte brut dans la source JavaScript, ce qui représente une cible facile. L’utilisation côté serveur garantit un niveau de sécurité élevé. Consultez le document relatif aux meilleures pratiques sur la sécurité des clés pour en savoir plus.

La sécurité interdomaines est aussi importante. Les stratégies du navigateur en matière de sécurité interdomaines rendent difficile la mise en œuvre des applications AJAX. La technique utilisée pour les exemples de cette section est la balise de script dynamique, détaillée plus loin.

Les requêtes JavaScript vous empêchent de profiter des avantages de la SEO qu'offre l'API médias pour intégrer les métadonnées à vos pages. Les robots des moteurs de recherche n'exécutent pas le code JavaScript. Consultez le document sur les meilleures pratiques en matière de SEO avec l'API médias.

Nous conseillons l’utilisation d’un langage côté serveur, comme le PHP, Java ou ColdFusion pour exploiter l’API médias.

Introduction de requêtes et analyse des résultats

Le moyen de plus simple d’introduire les requêtes HTTP interdomaines adressées à l’API médias est représenté par les balises de script dynamique. L’attribut src de la balise de script ne fait pas l'objet d'un contrôle de domaine par les navigateurs. En d'autres termes, vous pouvez configurer la balise src comme étant une URL définie sur un autre serveur afin de permettre la communication interdomaines. Les données renvoyées par le serveur en cas de requête src doivent constituer un code JavaScript valable. L’API médias permet de définir un paramètre « callback ». Ce faisant, la réponse JSON est encapsulée dans une requête de fonction dont le nom correspond à la valeur du paramètre de rappel. Par exemple :

// Effectuez une requête telle que :
http://api.brightcove.com/services/library?queryparams&callback=response
 
// et la réponse renvoyée sera :
// réponse(... données json...);
//
// qui invoquera une fonction « response » définie dans votre code

Dans cette méthode, la partie la plus compliquée consiste à créer la syntaxe de la requête. Comme la réponse se présente sous la forme d'objet JavaScript, la partie la plus complexe en termes de gestion de la réponse consiste à analyser les résultats et les afficher conformément aux critères de votre site. La syntaxe propre aux requêtes relatives à l’API médias (lecture) doit se présenter sous la forme suivante :

<URL>?command=<method_name>&<arguments>=<values>&token=<API_token>

L'URL de tous les appels API médias (lecture) de Brightcove est http://api.brightcove.com/services/library. L'URL de tous les appels API médias (écriture) de Brightcove est http://api.brightcove.com/services/post.

Prochaines étapes

Les documents suivants vous fournissent quelques exemples pour bien démarrer :

Balises
JavaScript