Prime Video bietet Partnern zwei umfassende API-Suiten, die entwickelt wurden, um das Inhaltsmanagement zu optimieren und wertvolle Geschäftsinformationen zu liefern. In diesem Handbuch wird der komplette Onboarding-Prozess sowohl für die Content API Suite als auch für die Analytics API Suite beschrieben, einschließlich der Authentifizierungsanforderungen, der technischen Einrichtung und der wichtigsten Unterschiede zwischen den beiden.
Schritt 1: Zugriff anfordern und Zugangsdaten generieren
Wende dich an deinen Prime Video-Kontakt oder stelle über Kontakt eine Zugriffsanfrage, um den Zugriff in der Content API Suite anzufordern.
Schritt 2: Zugangsdaten generieren und absenden
Sobald deine Zugriffsanfrage genehmigt wurde, generiere für jede Umgebung einen privaten Schlüssel und eine Certificate Signing Request (CSR) und teile diese mit deinem Prime Video-Ansprechpartner.
Deine CSR generieren
Du kannst jedes Zertifikatstool verwenden, um deine CSRs zu generieren. Wenn du OpenSSL verwenden möchtest, kannst du die folgenden beiden Befehle ausführen:openssl genrsa -out client.key 2048
openssl req -new -key client.key -out prod_client.csr
Deine CSR an deinen Prime Video-Kontakt senden
Die CSR enthält alle Informationen, die wir benötigen, um dein API-Zertifikat zu generieren. Dies ist die Datei, die du deinem Kontakt als Teil deiner Onboarding-Anfrage sendest. Sobald Prime Video deine CSR erhalten hat, benötigst du diese Datei nicht mehr.
Hinweis: Es ist sehr wichtig, dass du deine privaten Schlüsseldateien sicher aufbewahrst und niemals an Dritte weitergibst, auch nicht an Prime Video. Wir werden niemals nach dieser Datei fragen. Du wirst sie später verwenden, wenn du deine API-Aufrufe an uns tätigst.
Schritt 3: Deine Zugangsdaten erhalten
Sobald deine Anfrage genehmigt wurde, erhältst du vom Prime Video-Team eine E-Mail mit den folgenden Informationen:
- Das öffentliche Zertifikat, das du für Aufrufe an uns verwendest.
- Dein API-Schlüssel für Anfrageheader
- Die URL-Endpunkte für die API-Aufrufe.
- Informationen über das TPS, für das du mit deinem Zertifikat konfiguriert bist.
Schritt 4: Deine Integration konfigurieren
Herzlichen Glückwunsch! Du kannst jetzt deinen privaten Schlüssel, dein öffentliches Zertifikat und deinen API-Schlüssel verwenden, um die API aufzurufen. Hier sind einige Beispiele für Integrationen, die verschiedene Technologien verwenden:
Bashbash
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
PythonPython 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) => {
// ...
});
Schritt 5: Deine Integration testen
Für die Avails API bieten wir Testsupport an, um sicherzustellen, dass du Avails erfolgreich über die API einreichen, aktualisieren und ablaufen lassen kannst. Da sich diese Vorgänge direkt auf die Ressourcen auswirken (nicht nur auf den Datenabruf), empfehlen wir allen Partnern dringend, ihre Integration gründlich zu testen. Da die APIs Offer Status und Asset Status schreibgeschützt sind, kannst du sie mit dem Produktionskonto testen.
Schritt 6: Beginnen, die API zu verwenden
Herzlichen Glückwunsch! Deine Tests sind abgeschlossen und validiert. Du kannst jetzt beginnen, die Produktionsumgebung mit deinen Produktionszugangsdaten zu verwenden, um deine Inhalte auf Prime Video zu verwalten. Deine Integration ist bereit, deine Inhaltsabläufe zu optimieren und deinen Katalog in Echtzeit einzusehen.
Schritt 1: Dein Sicherheitsprofil erstellen
Im Rahmen dieses Schritts richtest du die Zugangsdaten für die Anwendung ein und konfigurierst deine Authentifizierungseinstellungen über die Entwicklerkonsole von Amazon.
Deine Anwendung registrieren
- Navigiere zur Amazon Developer Console, um den Registrierungsprozess zu starten
- Melde dich mit deinem bestehenden Amazon-Entwicklerkonto an oder erstelle ein neues Konto, falls du noch keines hast
- Klicke auf Neues Sicherheitsprofil erstellen, um mit der Konfiguration der Authentifizierungseinstellungen deiner Anwendung zu beginnen
Mein Profil konfigurieren
- Sicherheitsprofilname: Wähle einen aussagekräftigen Namen, der deine Integration eindeutig identifiziert (z. B. „Leistungsdatenintegration“ oder „Analytics-API-Zugang“)
- Beschreibung: Erläutere klar und deutlich den Zweck deiner Anwendung und wie sie die Analytics-APIs verwenden wird
- URL der Datenschutzerklärung: Füge eine URL hinzu, die den Benutzenden erklärt, wie deine Anwendung mit ihren Daten umgeht und sie schützt
- Klicke auf Speichern, um dein Sicherheitsprofil zu erstellen
- Nach der korrekten Einrichtung solltest du eine Erfolgsmeldung erhalten
Meine Weiterleitungs-URL festlegen
- Gehe zu deinem Profil und wähle die Registerkarte Sicherheitsprofile aus, um dein neu erstelltes Sicherheitsprofil zu verwalten:
- Wähle dann Webeinstellungen, um das Weiterleitungsverhalten deiner Anwendung zu konfigurieren
- Füge deine Weiterleitungs-URL hinzu – Dies ist der sichere Endpunkt, an den Benutzende nach der Autorisierung deiner Anwendung gesendet werden (für die lokale Entwicklung muss https:// oder https://localhost verwendet werden)
Wichtig: Speicher diese URL sicher – du musst im nächsten Schritt genau diese URL verwenden, wenn du deinen Autorisierungscode generierst.
Deine Zugangsdaten erhalten
- Navigiere zur Registerkarte Webeinstellungen, um auf deine Anwendungszugangsdaten zuzugreifen
- Kopiere deine Client-ID (diese dient als eindeutige Kennung deiner Anwendung) und Client Secret (dies dient als Passwort deiner Anwendung)
- Speicher beide Zugangsdaten sicher im Geheimmanagementsystem deiner Organisation – diese werden zur Authentifizierung all deiner API-Anfragen verwendet
Schritt 2: Deine Anwendung autorisieren
Im Rahmen dieses Schritts autorisierst du deine Anwendung, im Namen deiner Organisation auf Prime Video Slate zuzugreifen, und legst die Berechtigungen fest, die zum Abrufen von Leistungsdaten und Analysen über die APIs erforderlich sind.
Deine Anwendung zu Slate hinzufügen
- Melde dich mit den Zugangsdaten deiner Organisation bei deinem Prime Video Slate-Konto an
- Navigiere in der oberen rechten Ecke zu Kontoeinstellungen und wähle dann Anwendungen aus dem Drop-down-Menü
- Klicke auf Anwendung hinzufügen, um den Autorisierungsvorgang zu starten
- Gib deine Kunden-ID (aus Schritt 1) in das dafür vorgesehene Feld ein
- Wähle das Kontrollkästchen Berichte aus, um deiner Anwendung Zugriff auf Leistungsdaten und Berichte zu gewähren
- Klicke auf Anwendung hinzufügen, um die Registrierung in Slate abzuschließen
Deinen Autorisierungscode generieren
- Erstelle deine Autorisierungs-URL, indem du die Platzhalter in Klammern durch deine tatsächlichen Zugangsdaten aus Schritt 1 ersetzt:
https://www.amazon.com/ap/oa?client_id=[YOUR_CLIENT_ID]&redirect_uri=[YOUR_REDIRECT_URI]&scope=videocentral::reports:read&response_type=code:
- Öffne diese URL in deinem Webbrowser, um den Autorisierungsablauf zu starten
- Melde dich mit deinen Slate-Kontozugangsdaten an, wenn du dazu aufgefordert wirst
- Überprüfe die Berechtigungen, die deine Anwendung anfordert und klicke dann auf Zulassen, um Zugriff zu gewähren
- Nach der Autorisierung wirst du zu deiner angegebenen Weiterleitungs-URL weitergeleitet. Kopiere den Autorisierungscode aus der Abfragezeichenfolge der URL (er wird angezeigt als
?code=YOUR_CODE
Bewährtes Verfahren: Wir empfehlen, ein eigenes Slate-Konto (z. B. api_access@yourcompany.com) mit den minimal erforderlichen Berechtigungen speziell für den API-Zugriff zu erstellen. Dieser Ansatz erhöht die Sicherheit und erleichtert die Verwaltung und Prüfung der API-Nutzung in deinem Unternehmen.
Hinweis: Wenn du die Berechtigungen des oder der autorisierenden Nutzenden für die Verwendung von Berichten entfernst, ist auch die Anwendung berechtigt, gesperrte Berichte zu verwenden.
Schritt 3: Deine Zugriffstoken anfordern
Im Rahmen dieses Schritts verwendest du deinen Autorisierungscode, um die Token zu erhalten, die für authentifizierte API-Aufrufe erforderlich sind. Das Zugriffstoken ermöglicht es deiner Anwendung, Leistungsdaten abzurufen, während das Aktualisierungstoken es dir ermöglicht, neue Zugriffstoken zu generieren, ohne den Autorisierungsprozess zu wiederholen.
Autorisierungscodes sind einmalig verwendbare Token. Wenn sie zum Abrufen eines access_token verwendet werden, wird ein refresh_token zurückgegeben, das wiederum zum Abrufen des nächsten access_token verwendet werden kann. Der folgende Abschnitt führt dich durch den Abruf deines ersten refresh_token.
Erste Token-Anfrage (nur beim ersten Mal):
Um ein Token anzufordern:
- Gib client_id, client_secret, authorization_code und grant_type als URL-kodierte Formulardaten ein.
- Stelle eine HTTP-Anfrage.
Der curl-Befehl zum Generieren von Tokens aus authorization_code wird im folgenden Beispiel gezeigt.
curl --request POST \
--url https://api.amazon.com/auth/o2/token \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token' \
--data 'client_id=amzn1.application-oa2-client.20534a91be57487e9c3547dada8a7394' \
--data 'client_secret=c007c411c9657dde807a11a96a3cfd8a2972f9599ac28de241675832f63cac05' \
--data 'refresh_token=Atzr|IwEBIPw8sQi6vSq67a0QeWDjRp4DJusAHG9kg-707e9PVbCbFTD3mU3H9ztkXppkSfeIgGsq
d4zDnwr5y5hbFZvqyEQPsPRPNspT4cyWNhS6teaQsgyQa6CDTEejwYksDC4rQCi77p67zAkVzh6vHAuVJwkmaXH8IFFouRvR5gp
qrffASpNv1eZwLTyqJzMNyU2CNJrIgurqJmByJN3u-smxLkshqMej0anoykw8qyNTmNxrzYRZJR2KdZLH6Kcw9mO41zHJKVWKi_
My4_bevVGd8viCGUeXeaRgOONI-GtGoQOZV7NwERLFkjT8Imw_yu4AeZ9lXEomFTy61RhieWvpxJmHNDb6MRuJcywFhx-h2fw1I
jxP-W3J6HuVME69UMdapNkgk3bfgpWCsfkxDP3Qq1MddDkYvoTuJPAtqq12X4hvmlM1OZWsy8uG0Pckb9S3D1rh4g06pWcx-VaW
GXQr2hbP58DWWQYIbLW-kZHD0eakoqNdrOtj56IMZZTz7RAPdmHiiHScDkgu6PyiBFBDBV7V'
Aktualisieren deiner Zugriffstoken:
Verwende für alle nachfolgenden Sitzungen nach deiner ersten Token-Anfrage dein Aktualisierungstoken, um neue Zugriffstoken zu erhalten: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]'
Schritt 4: Deine Anwendung konfigurieren
Herzlichen Glückwunsch! Du hast jetzt alle Zugangsdaten, die du zum Aufrufen der Performance-APIs benötigen. Im Rahmen dieses Schritts konfigurierst du deine Anwendung so, dass dein Zugriffstoken in den Autorisierungsheader jeder API-Anfrage aufgenommen wird, sodass du Abonnementdaten, Leistungskennzahlen und Analysen für deine Inhalte abrufen kannst.
Beispiel für eine API-Anfrage:
curl --request GET \
--url https://videocentral.amazon.com/apis/v1/accounts \
--header 'authorization: bearer Atza|IwEBIPSxTCdGGC-xL-ywFib_lJfg-D7d435Jw739GWa3xy6dHJ
Dieses Beispiel zeigt, wie du deine Anfragen authentifizierst – ersetze [YOUR_ACCESS_TOKEN]
Schritt 5: Integration testen
Wir empfehlen allen Partnern dringend, ihre Integration gründlich zu testen, um einen zuverlässigen Zugriff auf Leistungsdaten zu gewährleisten. Im Rahmen dieses Schritts überprüfst du, ob dein Authentifizierungsablauf ordnungsgemäß funktioniert, deine API-Aufrufe die erwarteten Daten zurückgeben und deine Fehlerbehandlung ordnungsgemäß konfiguriert ist.
Schritt 6: Mit der Verwendung beginnen
Sobald deine Tests abgeschlossen sind und du bestätigt hast, dass deine Integration zuverlässig funktioniert, kannst du die Produktionsumgebung verwenden, um Leistungsdaten und Analysen für deine Inhalte auf Prime Video in Echtzeit abzurufen. Deine Datenpipelines können jetzt die Datensatzdateien, die nur angehängt werden können, verwenden, um die granularen Analysen durchzuführen, die dein Unternehmen benötigt.
Lies mehr über die Analytics-API-Datenframeworks, die hier verfügbar sind:
