Prime Video propose à ses partenaires deux suites d’API complètes conçues pour rationaliser la gestion du contenu et fournir des informations commerciales précieuses. Ce guide décrit le processus d’intégration complet pour la suite Content API et la suite API Analytics, y compris les exigences d’authentification, la configuration technique et les principales différences entre les deux.
Étape 1 : demander l’accès et générer des informations d’identification
Contactez votre contact Prime Video ou soumettez une demande d’accès via Contactez-nous pour demander un accès à la suite Content API.
Étape 2 : Générer les informations d’identification et 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 exécuter les deux commandes suivantes : openssl genrsa -out client.key 2048
openssl req -new -key client.key -out prod_client.csr
Soumettre votre CSR à votre contact Prime Video
Le CSR contient toutes les informations dont nous avons besoin pour générer votre certificat 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 demanderons jamais ce fichier. Vous l’utiliserez ultérieurement lorsque vous nous appellerez à l’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é d’API pour les en-têtes de demande
- Les points de terminaison d’URL pour les appels d’API.
- Informations sur le TPS pour lequel vous êtes configuré avec votre certificat.
Étape 4 : Configuration de votre intégration
Voici des exemples d’intégrations utilisant différentes technologies : Bash
bash
curl --location --request PUT 'https://partnerapi.primevideo.com/v1/avails/{partnerAlias}/full-extract/{ALID}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: <api key>' \
--data-raw '{ "avail": <Avail json> }' \
--key ./private_key.txt --cert ./certificate.pem
Python
Python https://requests.readthedocs.io/en/master/user/advanced/#client-side-certificates
requests.put(f'https://partnerapi.primevideo.com/v1/avails/{partnerAlias}/full-extract/{ALID}',
data={'{ "avail": <Avail json> }'},
cert=('/path/client.cert', '/path/client.key'),
headers={'x-api-key':'<api key>','Content-Type':'application/json'})
Node.js
Nodejs https://nodejs.org/api/https.html#https_https_request_options_callback
const options = {
hostname: `https://partnerapi.primevideo.com/v1/avails/{partnerAlias}/full-extract/{ALID}`,
port: 443,
path: `/v1/avails/{partnerAlias}/full-extract/{ALID}`,
method: 'PUT',
headers: {
'Content-Type':'application/json',
'x-api-key':'<api key>'
},
key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
agent: false
};
const req = https.request(options, (res) => {
// ...
});
Étape 5 : Testez votre intégration
En ce qui concerne les Renseignements utiles, nous offrons une assistance en matière de test afin de nous assurer que vous pouvez envoyer, mettre à jour et faire expirer Avail avec succès via l’API. Étant donné que ces opérations ont un impact direct sur les actifs (et 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. En ce qui concerne les API Statut de l’offre et Statut des actifs, étant donné qu’elles sont en lecture seule, vous pouvez les tester à l’aide du compte de 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 identifiants 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.
Étape 1 : Créer 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 console de développement d’Amazon.
Enregistrez votre candidature
- Accédez à l’Amazon Developer Console pour commencer le processus d’enregistrement
- Connectez-vous avec votre compte de 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 à l’API Analytics »)
- Description : Expliquez clairement l’objectif de votre application et la manière dont elle utilisera les API Analytics
- URL de l’avis de confidentialité : incluez une URL expliquant aux utilisateurs comment votre application gérera et protégera leurs données
- Cliquez sur Sauvegarder pour créer votre profil de sécurité
- Vous devriez recevoir un message de confirmation une fois la configuration correcte
Définissez votre URL de redirection
- Accédez à votre profil et sélectionnez les onglets « Profil de sécurité » à gérer sur votre profil de sécurité nouvellement créé :
- Sélectionnez ensuite Paramètres Web pour configurer le comportement de redirection de votre application
- Ajouter votre URL de redirection : il s’agit du point de terminaison sécurisé vers lequel les utilisateurs seront envoyés après avoir autorisé votre application (vous devez utiliser https ://ou https://localhost pour le développement local)
Important : Sauvegardez cette URL de manière sécurisée. 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 (qui sert d’identifiant unique à votre application) et votre secret client (qui sert de mot de passe pour votre application)
- Stockez les deux informations d’identification en toute sécurité dans le système de gestion des secrets de votre entreprise. Elles seront utilisées pour authentifier toutes vos demandes d’API
Étape 2 : Autoriser votre demande
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.
Ajouter votre candidature à 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
- Entrez votre ID 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 de performance et aux rapports
- 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 à l’étape 1 :
https://www.amazon.com/ap/oa?client_id=[YOUR_CLIENT_ID]&redirect_uri=[YOUR_REDIRECT_URI]&scope=videocentral::reports:read&response_type=code
- 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
?code=YOUR_CODE
Bonne pratique : nous vous recommandons de créer un compte Slate dédié (par exemple, api_access@yourcompany.com) avec les autorisations minimales requises, spécifiquement pour l’accès aux API. Cette approche améliore la sécurité et facilite la gestion et l’audit de l’utilisation des API au sein de votre organisation.
Remarque : Si vous supprimez les autorisations d’utilisation des rapports de l’utilisateur autorisé, l’application verra également son autorisation d’utiliser les rapports révoquée.
É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 d’API authentifiés. Le jeton d’accès permet à votre application de récupérer les données de performance, 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 sont des jetons à usage unique. Lorsqu’ils sont utilisés pour récupérer un access_token, ils renvoient un refresh_token qui peut être utilisé pour récupérer le jeton d’accès suivant. La section suivante vous explique comment récupérer votre premier refresh_token.
Demande initiale de jeton (première fois uniquement) :
pour demander un jeton :
- Entrez les champs client_id, client_secret, authorization_code et grant_type sous forme de données de formulaire codé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.
curl --request POST \
--url https://api.amazon.com/auth/o2/token \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'grant_type=authorization_code' \
--data 'code=[AUTH_CODE]' \
--data 'client_id=[ID]' \
--data 'client_secret=[SECRET] \
--data 'redirect_uri=[URI]'
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 : bash
curl --location --request POST 'https://api.amazon.com/auth/o2/token' \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token' \
--data 'client_id=[YOUR_CLIENT_ID]' \
--data 'client_secret=[YOUR_CLIENT_SECRET]' \
--data 'refresh_token=[YOUR_REFRESH_TOKEN]'
Étape 4 : Configuration de votre application
Félicitations ! Vous disposez désormais de toutes les informations d’identification nécessaires pour appeler les API de 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 d’API, ce qui vous permettra de récupérer les données d’abonnement, les indicateurs de performance et les analyses de votre contenu.
Exemple de demande d’API :
curl --request GET \
--url https://videocentral.amazon.com/apis/v1/accounts \
--header 'authorization: bearer Atza|IwEBIPSxTCdGGC-xL-ywFib_lJfg-D7d435Jw739GWa3xy6dHJ
Cet exemple montre comment authentifier vos demandes : remplacez[YOUR_ACCESS_TOKEN]
Étape 5 : Tester l’intégration
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 d’API renvoient les données attendues et que votre gestion des erreurs est correctement configurée.
Étape 6 : Commencez à utiliser
Une fois que vos tests sont terminés et que vous avez confirmé la fiabilité de votre intégration, 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 jeux de données à ajouter uniquement pour effectuer les analyses granulaires dont votre organisation a besoin.
Pour en savoir plus sur les frameworks de données de l’API Analytics, cliquez ici :