Video Central

Intégration à la suite Content API

La suite Content API vous permet d’automatiser les flux de travail de gestion de contenu et de bénéficier d’une visibilité en temps réel sur le statut de votre contenu sur Prime Video. Cette suite comprend :

Renseignements utiles — Soumettre, mettre à jour, récupérer et supprimer les droits de contenu (avails) de manière programmatique dans tous les secteurs d’activité et territoires
API de statut de l’offre : vérifiez si vos titres sont en ligne sur la boutique Prime Video et comprenez ce qui empêche la mise en ligne des titres
API d’état des actifs : surveillez l’état de livraison des actifs et recevez des informations instantanées sur l’état de préparation du contenu

Lorsque vous intégrez la Content API Suite, vous aurez accès aux API que vous demandez au cours du processus d’intégration. Tous/Toutes les API de cette suite utilisent l’authentification basée sur des certificats MTLS (Mutual Transport Layer Security) avec des clés d’API.

Étape 1 : Demande d’accès et génération d’informations d’identification

Contactez votre contact Prime Video ou soumettez une demande d’accès via Contactez-nous pour demander l’accès à la suite Content API.

Étape 2 : Générer des informations d’identification et les soumettre

Une fois votre demande d’accès approuvée, générez une clé privée et une demande de signature de certificat (CSR) pour chaque environnement et partagez-les avec votre contact Prime Video désigné.

Générez votre CSR
Vous pouvez utiliser n’importe quel outil de certification pour générer vos CSR. Si vous souhaitez utiliser OpenSSL, vous pouvez lancer les deux commandes suivantes :

La première commande générera votre fichier de clé privée avec l’extension « key ».
La deuxième commande générera votre demande de signature de certificat (CSR) avec l’extension de fichier « csr ». Vous devrez transmettre le chemin du fichier client.key que vous venez de créer. La convention de dénomination recommandée pour le fichier de sortie est <Partner Name>_ <Prod or Sandbox>_client.csr.

Soumettez votre CSR à votre contact Prime Video
Le CSR contient toutes les informations dont nous avons besoin pour générer votre certificat d’API. Il s’agit du fichier que vous enverrez à votre contact dans le cadre de votre demande d’intégration. Une fois que Prime Video aura reçu votre CSR, vous n’aurez plus besoin de ce fichier.

Remarque : Il est très important de protéger vos fichiers de clé privée et de ne jamais les partager avec qui que ce soit, y compris Prime Video. Nous ne vous demanderons jamais ce fichier. Vous l’utiliserez ultérieurement lors de vos appels API.

Étape 3 : Recevez vos informations d’identification

Une fois votre demande approuvée, vous recevrez un e-mail de l’équipe Prime Video contenant les informations suivantes :

Le certificat public que vous utiliserez pour nous appeler.
Votre clé API pour les en-têtes de requête
Les points de terminaison des URL pour les appels d’API.
Informations sur le TPS pour lequel vous êtes configuré avec votre certificat.

Étape 4 : Configurez votre intégration

Félicitations ! Vous pouvez désormais utiliser votre clé privée, votre certificat public et votre clé API pour appeler l’API. Voici des exemples d’intégrations utilisant différentes technologies :

Bash

Python

Node.js

Étape 5 : Testez votre intégration

Pour l’API Avails, nous proposons une assistance aux tests afin d’assurer que vous pouvez soumettre, mettre à jour et faire expirer les disponibilités via l’API. Étant donné que ces opérations ont un impact direct sur les actifs (pas seulement sur la récupération des données), nous recommandons vivement à tous les partenaires de tester leur intégration de manière approfondie. Pour les API Offer Status et Asset Status, étant donné qu’elles sont en lecture seule, vous pouvez effectuer les tests à l’aide du compte Production.

Étape 6 : Commencez à utiliser l’API

Félicitations ! Vos tests sont terminés et validés. Vous pouvez désormais commencer à utiliser l’environnement de production avec vos informations d’identification de production pour gérer votre contenu sur Prime Video. Votre intégration est prête à rationaliser vos opérations de contenu et à fournir une visibilité en temps réel sur votre catalogue.

FAQ sur Content API

Le calendrier d’intégration varie en fonction de votre niveau de préparation technique et de la complexité de votre intégration. Généralement, le processus inclut la fourniture des informations d’identification, l’examen de la documentation technique, le développement de l’intégration et les tests. Nous vous recommandons de laisser suffisamment de temps à votre équipe de développement pour créer et tester l’intégration avant de la mettre en ligne.

Si vous avez reçu vos identifiants d’API mais que vous avez besoin de conseils sur la mise en œuvre, contactez votre contact Prime Video ou contactez-nous pour discuter de vos besoins et de votre situation individuels. Nous pouvons vous fournir des conseils personnalisés sur :

Comment vous authentifier à l’aide de vos informations d’identification
Quels points de terminaison d’API sont les plus pertinents pour votre flux de travail
Bonnes pratiques en matière d’intégration et de test
Documentation technique et exemples de code

Intégration à la suite Analytics API

La suite d’API Analytics vous permet d’intégrer plusieurs points de terminaison pour les données de performance Prime Video directement dans vos propres systèmes et d’obtenir des informations plus approfondies sur les performances du contenu. Cette suite comprend :

Ensemble de données sur les performances : accédez aux données au niveau des événements pour une analyse granulaire et une intégration avec vos ensembles de données internes
Rapports — Récupérez des fichiers CSV statiques contenant des données sur les performances du contenu et les revenus de manière récurrente
État financier — Accédez à des comptes de résultats actualisés reflétant les données de votre tableau de bord financier dans Slate
Journal des événements d’abonnement - Accédez aux données d’abonnement au niveau des événements pour le suivi du parcours client

Tous/Toutes les extrémités d’API de cette suite utilisent l’authentification OAuth 2.0 et fournissent un accès en lecture seule aux données de performance. Contrairement aux autres rapports Slate, les ensembles de données de l’API Analytics ne peuvent être ajoutés qu’en ajout (chaque fichier contient de nouvelles données) et sont conçus explicitement pour que les ingénieurs partenaires puissent utiliser des données granulaires et effectuer des analyses.

Étape 1 : Créez votre profil de sécurité

Dans le cadre de cette étape, vous allez configurer les informations d’identification de l’application et vos paramètres d’authentification via la Developer Console d’Amazon.

Enregistrez votre candidature

Accédez à la Developer Console d’Amazon pour démarrer le processus d’inscription
Connectez-vous à l’aide de votre compte développeur Amazon existant ou créez-en un nouveau si vous n’en avez pas
Cliquez sur Créer un nouveau profil de sécurité pour commencer à configurer les paramètres d’authentification de votre application

Configurez votre profil

Nom du profil de sécurité : Choisissez un nom descriptif qui identifie clairement votre intégration (par exemple, « Intégration des données de performance » ou « Accès à Analytics API »)
Description : Fournissez une explication claire de l’objectif de votre application et de la manière dont elle utilisera les Analytics API
URL de la Notice Protection de vos informations personnelles : Incluez une URL expliquant aux utilisateurs comment votre application gérera et protégera leurs données
Cliquez sur Enregistrer pour créer votre profil de sécurité
Une fois la configuration effectuée correctement, vous devriez recevoir un message indiquant que l’opération a réussi

Définissez votre URL de redirection

Accédez à votre profil et sélectionnez les onglets du profil de sécurité pour gérer le profil de sécurité que vous venez de créer :
Sélectionnez ensuite Paramètres Web pour configurer le comportement de redirection de votre application
Ajoutez votre URL de redirection : il s’agit du point de terminaison sécurisé auquel les utilisateurs seront envoyés après avoir autorisé votre application (vous devez utiliser https ://ou https://localhost pour le développement local)

Important : Enregistrez cette URL en toute sécurité. Vous devrez utiliser cette URL exacte à l’étape suivante lors de la génération de votre code d’autorisation.

Recevez vos informations d’identification

Accédez à l’onglet Paramètres Web pour accéder aux informations d’identification de votre application
Copiez votre identifiant client (il sert d’identifiant unique à votre application) et votre code secret client (il s’agit du mot de passe de votre application)
Stockez les deux informations d’identification en toute sécurité dans le système de gestion des secrets de votre organisation. Elles seront utilisées pour authentifier toutes vos demandes API

Étape 2 : Autorisez votre application

Dans le cadre de cette étape, vous autoriserez votre application à accéder à Prime Video Slate au nom de votre organisation en établissant les autorisations nécessaires pour récupérer les données de performance et les analyses via les API.

Ajoutez votre application à Slate

Connectez-vous à votre compte Prime Video Slate à l’aide des informations d’identification de votre organisation
Accédez aux paramètres du compte dans le coin supérieur droit, puis sélectionnez Applications dans le menu déroulant

Cliquez sur Ajouter une application pour démarrer le processus d’autorisation

Saisissez votre numéro de client (à partir de l’étape 1) dans le champ prévu à cet effet
Cochez la case Rapports pour autoriser votre application à accéder aux données et aux rapports de performance
Cliquez sur Ajouter une application pour terminer l’enregistrement dans Slate

Générez votre code d’autorisation

Créez votre URL d’autorisation en remplaçant les espaces réservés entre crochets par vos informations d’identification réelles de l’étape 1 :

Pour obtenir le code d’autorisation, vous allez créer une URL spécifique à utiliser dans votre navigateur Web. Pour effectuer cette étape, vous aurez besoin des éléments suivants :

Le profil de sécurité de l’application client_id
Le redirect_url enregistré par l’application
Type de réponse de l’autorisateur : il doit s’agir d’un code
Champ d’autorisation : videocentral : :reports:read

Ouvrez cette URL dans votre navigateur Web pour lancer le flux d’autorisation
Connectez-vous avec les informations d’identification de votre compte Slate lorsque vous y êtes invité
Vérifiez les autorisations demandées par votre application, puis cliquez sur Autoriser pour accorder l’accès
Après autorisation, vous serez redirigé vers l’URL de redirection que vous avez spécifiée. Copiez le code d’autorisation à partir de la chaîne de requête de l’URL (il apparaîtra sous la forme

Meilleures pratiques : Nous vous recommandons de créer un compte Slate dédié (par exemple, api_access@yourcompany.com) avec des autorisations minimales requises spécifiquement pour l’accès à l’API. Cette approche renforce la sécurité et facilite la gestion et l’audit de l’utilisation des API au sein de votre organisation.

Remarque : Si vous n’autorisez plus l’utilisateur procédant à l’autorisation à exploiter des rapports, les autorisations similaires accordées à l’application sont également retirées à cette dernière.

Étape 3 : Demandez vos jetons d’accès

Dans le cadre de cette étape, vous utiliserez votre code d’autorisation pour obtenir les jetons nécessaires pour effectuer des appels API authentifiés. Le jeton d’accès permet à votre application de récupérer des données de performances, tandis que le jeton d’actualisation vous permet de générer de nouveaux jetons d’accès sans répéter le processus d’autorisation.

Les codes d’autorisation constituent des jetons à usage unique. Lorsqu’ils sont utilisés pour récupérer un jeton de type access_token, ils permettent d’obtenir un jeton de type refresh_token pouvant être employé pour récupérer le prochain jeton de type access_token. La section suivante vous indique comment récupérer votre premier jeton refresh_token.

Demande initiale de jeton (première fois uniquement) :
Pour demander un jeton :

Saisissez les champs client_id, client_secret, authorization_code et grant_type sous forme de données de formulaire encodées en URL.
Effectuez une requête HTTP.
La commande curl permettant de générer des jetons à partir de authorization_code est illustrée dans l’exemple suivant.

Vous recevrez :

access_token : Ce jeton de courte durée (expire dans 1 heure) est utilisé pour authentifier vos demandes d’API auprès des API de performance
refresh_token : ce jeton à longue durée de vie est utilisé pour générer de nouveaux jetons d’accès sans nécessiter une nouvelle autorisation de l’utilisateur. Stockez-le en toute sécurité car il fournit un accès continu à votre application

Actualisation de votre jeton d’accès :
Pour toutes les sessions suivantes après votre demande initiale de jeton, utilisez votre jeton d’actualisation pour obtenir de nouveaux jetons d’accès :

Étape 4 : Configurez votre application

Félicitations ! Vous disposez désormais de toutes les informations d’identification nécessaires pour appeler les API Performance. Dans le cadre de cette étape, vous allez configurer votre application pour inclure votre jeton d’accès dans l’en-tête d’autorisation de chaque demande API, ce qui vous permettra de récupérer les données d’abonnement, les mesures de performance et les analyses de votre contenu.

Exemple de demande API :

Cet exemple montre comment authentifier vos demandes : remplacez par le jeton d’accès réel que vous avez reçu à l’étape 3. Vous pouvez désormais utiliser ce modèle d’authentification pour accéder à tous les points de terminaison de l’API Performance disponibles et récupérer les fichiers de jeu de données accessibles en ajout uniquement qui contiennent des données granulaires pour vos pipelines d’analyse.

Étape 5 : Intégration des tests

Nous recommandons vivement à tous les partenaires de tester minutieusement leur intégration afin de garantir un accès fiable aux données de performance. Dans le cadre de cette étape, vous allez vérifier que votre flux d’authentification fonctionne correctement, que vos appels API renvoient les données attendues et que votre gestion des erreurs est correctement configurée.

Vérifiez l’authentification : vérifiez que votre jeton d’accès authentifie correctement les demandes d’API en effectuant un simple appel de test au point de terminaison du compte
Extraction des données de test : vérifiez que vous pouvez récupérer les données de performance avec succès et que le format de réponse correspond à vos attentes
Implémentation de la gestion des erreurs : créez une gestion des erreurs robuste pour les scénarios courants, notamment les jetons expirés, la limitation du débit et les problèmes de réseau
Valider la logique d’actualisation des jetons : testez l’implémentation de votre jeton d’actualisation pour vous assurer que votre application peut obtenir automatiquement de nouveaux jetons d’accès sans intervention manuelle
Confirmez la gestion de l’expiration des jetons : vérifiez que votre intégration détecte correctement l’expiration des jetons d’accès (après 1 heure) et les actualise automatiquement avant d’effectuer les appels d’API suivants

Étape 6 : Commencer l’utilisation

Une fois vos tests terminés et après avoir vérifié que votre intégration fonctionne correctement, vous pouvez commencer à utiliser l’environnement de production pour récupérer des données de performance et des analyses en temps réel pour votre contenu sur Prime Video. Vos pipelines de données peuvent désormais utiliser les fichiers de jeu de données accessibles uniquement en ajout pour effectuer les analyses granulaires dont votre organisation a besoin.

Pour en savoir plus sur les cadres de données Analytics API disponibles, cliquez ici :

FAQ sur Analytics API

Si les informations d’identification de votre application ont été compromises (par exemple, si elles ont été accidentellement enregistrées dans un référentiel de code public) :

Accédez à la console de connexion avec Amazon
Trouvez votre profil de sécurité et cliquez sur Gérer, puis sélectionnez Profil de sécurité
Cliquez sur Supprimer le profil de sécurité et tapez « supprimer » dans le champ de confirmation pour continuer

Important : la suppression de votre profil de sécurité invalide immédiatement tous les jetons d’accès et d’actualisation existants pour tous les utilisateurs, et empêche toute utilisation future de ces informations d’identification. Vous devrez créer un nouveau profil de sécurité et répéter l’intégralité du processus d’intégration si vous souhaitez rétablir l’accès à l’API.

Stockez votre secret client et votre jeton d’actualisation dans le système de gestion sécurisé des secrets de votre organisation. Ne codez jamais ces valeurs en dur dans le code de votre application ou dans les fichiers de configuration. Ces informations d’identification donnent accès à votre intégration de l’API Performance et doivent être traitées selon les mêmes normes de sécurité que les mots de passe ou les clés d’API.

Non Ne communiquez jamais d’informations d’identification à des référentiels de code, ne les partagez jamais par e-mail ou ne les incluez jamais dans la documentation ou les tickets d’assistance. Si des informations d’identification sont accidentellement exposées dans un référentiel public, supprimez immédiatement votre profil de sécurité et créez-en de nouvelles après le processus d’intégration.

Les jetons d’accès expirent au bout d’une heure. Implémentez une logique d’actualisation automatique des jetons dans votre application pour garantir un accès ininterrompu aux API. Votre application doit détecter le moment où les jetons sont sur le point d’expirer ou ont expiré, puis utiliser votre jeton d’actualisation pour obtenir un nouveau jeton d’accès avant d’effectuer les appels d’API suivants.

Mettez en œuvre la journalisation et la surveillance pour suivre les habitudes d’utilisation de vos API, notamment les volumes de demandes, les taux d’erreur et les tentatives d’authentification. Configurez des alertes en cas d’activité inhabituelle susceptible d’indiquer des informations d’identification compromises, telles que des demandes provenant d’adresses IP inattendues, des modèles de demandes inhabituels ou des échecs d’authentification répétés.

Intégration à l’API