Prime Video ofrece a los socios dos paquetes de API integrales diseñados para agilizar la gestión de contenido y ofrecer información empresarial valiosa. Esta guía describe el proceso completo de incorporación de la suite de API de contenido y la suite de API de Analytics, incluidos los requisitos de autenticación, la configuración técnica y las diferencias clave entre ambos.
Paso 1: Solicita acceso y genera las credenciales
Comunícate con tu contacto de Prime Video o presenta una solicitud de acceso a través de Contáctanos para solicitar el acceso a la suite de API de contenido.
Paso 2: Genera las credenciales y envíalas
Una vez que se apruebe tu solicitud de acceso, genera una clave privada y una solicitud de firma de certificado (CSR) para cada entorno y compártelas con tu contacto de Prime Video designado.
Genera tu CSR
Puedes usar cualquier herramienta de certificación para generar tus CSR. Si deseas utilizar OpenSSL, puede poner en marcha los dos comandos siguientes:openssl genrsa -out client.key 2048
openssl req -new -key client.key -out prod_client.csr
Envía tu CSR a tu contacto de Prime Video
La CSR contiene toda la información que necesitamos para generar tu certificado de API. Este es el archivo que enviarás a tu contacto como parte de tu solicitud de incorporación. Una vez que Prime Video reciba tu CSR, no volverás a necesitar este archivo.
Nota: Es muy importante que protejas tus archivos de claves privadas y que nunca los compartas con nadie, ni siquiera con Prime Video. Nunca te pediremos este archivo. Lo usarás más adelante, cuando nos hagas tus llamadas a la API.
Paso 3: Recibe tus credenciales
Cuando se apruebe tu solicitud, recibirás un correo electrónico del equipo de Prime Video con la siguiente información:
- El certificado público que utilizarás para llamarnos.
- Tu clave de API para los encabezados de solicitud
- Los puntos de conexión (endpoints) de URL para las llamadas a la API.
- Información sobre el TPS que tienes configurado con tu certificado.
Paso 4: Configura tu integración
¡Felicidades! Ahora puedes usar tu clave privada, certificado público y clave de API para llamar a la API. A continuación, se muestran ejemplos de integraciones que usan diferentes tecnologías:
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) => {
// ...
});
Paso 5: Pon a prueba tu integración
Para la API de Avails, ofrecemos soporte de pruebas para garantizar que puedas enviar, actualizar y dar de baja correctamente las versiones disponibles a través de la API. Dado que estas operaciones afectan directamente a los activos (no solo a la recuperación de datos), recomendamos encarecidamente a todos los socios que prueben minuciosamente su integración. En el caso de las API de estado de la oferta y estado de los activos, dado que son de solo lectura, puedes realizar pruebas con la cuenta de producción.
Paso 6: Comienza a usar la API
¡Felicidades! La prueba está completa y validada. Ahora puedes empezar a usar el entorno de producción con tus credenciales de producción para administrar tu contenido en Prime Video. Tu integración está lista para optimizar tus operaciones de contenido y ofrecer visibilidad en tiempo real de tu catálogo.
Paso 1: Crea tu perfil de seguridad
Como parte de este paso, configurarás las credenciales de la aplicación y la configuración de autenticación por medio de la consola para desarrolladores de Amazon.
Registra tu solicitud
- Navega hasta la Consola para desarrolladores de Amazon para iniciar el proceso de registro
- Inicia sesión con tu cuenta de desarrollador de Amazon existente o crea una nueva si no tienes una
- Haz clic en Crear un nuevo perfil de seguridad para empezar a configurar los ajustes de autenticación de la aplicación
Configura tu perfil
- Nombre del perfil de seguridad: Elige un nombre descriptivo que identifique claramente tu integración (por ejemplo, “Integración de datos de rendimiento” o “Acceso a la API de Analytics”)
- Descripción: Proporciona una explicación clara del propósito de tu aplicación y de cómo utilizarás las API de Analytics
- URL del Aviso de privacidad: Incluye una URL que explique a los usuarios cómo tu aplicación gestionará y protegerá sus datos
- Haz clic en Guardar para crear tu perfil de seguridad
- Deberás recibir un mensaje de éxito una vez que lo hayas configurado de manera correcta
Establece la URL de redireccionamiento
- Ve a tu perfil y selecciona las pestañas de Perfil de seguridad para Gestionar en tu perfil de seguridad recién creado:
- A continuación, selecciona Configuración web para configurar el comportamiento de redireccionamiento de la aplicación
- Agrega tu URL de redireccionamiento: este es el punto de conexión (endpoint) seguro al cual se redirigirá los usuarios después de autorizar tu aplicación (debes usar https:// o https://localhost para el desarrollo local)
Importante: Guarda esta URL de forma segura: tendrás que usar esta URL exacta en el siguiente paso cuando generes tu código de autorización.
Recibe tus credenciales
- Navega a la pestaña Configuración web para acceder a las credenciales de tu aplicación
- Copia tu identificador de cliente (sirve como identificador único de tu aplicación) y tu secreto de cliente (actúa como la contraseña de tu aplicación)
- Almacena ambas credenciales de forma segura en el sistema de gestión de secretos de tu organización; estas se usarán para autenticar todas tus solicitudes de API
Paso 2: Autoriza tu solicitud
Como parte de este paso, autorizarás a tu aplicación a acceder a Prime Video Slate en nombre de tu organización y establecerás los permisos necesarios para recuperar los datos de rendimiento y los análisis a través de las API.
Agrega tu aplicación a Slate
- Inicia sesión en tu cuenta de Prime Video Slate con las credenciales de tu organización
- Ve a Configuración de la cuenta en la esquina superior derecha y, a continuación, selecciona Aplicaciones en el menú desplegable
- Haz clic en Agregar aplicación para iniciar el proceso de autorización
- Ingresa tu identificador de cliente (del paso 1) en el campo correspondiente
- Selecciona la casilla Informes para conceder a tu aplicación el acceso a los datos e informes de rendimiento
- Haz clic en Agregar solicitud para completar el registro en Slate
Genera tu código de autorización
- Crea tu URL de autorización al sustituir los marcadores de posición entre corchetes por tus credenciales actuales del paso 1:
https://www.amazon.com/ap/oa?client_id=[YOUR_CLIENT_ID]&redirect_uri=[YOUR_REDIRECT_URI]&scope=videocentral::reports:read&response_type=code:
- Abre esta URL en tu navegador web para iniciar el flujo de autorización
- Inicia sesión con las credenciales de tu cuenta de Slate cuando se te pida
- Revisa los permisos que solicita tu aplicación y, a continuación, haz clic en Permitir para conceder el acceso
- Una vez autorizada, se te redirigirá a la URL de redireccionamiento especificada. Copia el código de autorización de la cadena de consulta de la URL (aparecerá como
?code=YOUR_CODE
Prácticas recomendadas: Recomendamos crear una cuenta de Slate dedicada (por ejemplo, api_access@yourcompany.com) con los permisos mínimos necesarios específicamente para el acceso a la API. Este enfoque mejora la seguridad y facilita la administración y la auditoría del uso de las API en toda la organización.
Nota: Si elimina los permisos del usuario que autoriza para usar informes, entonces también se revocarán los permisos de la aplicación para usar informes.
Paso 3: Solicita tus token de acceso
Como parte de este paso, usarás tu código de autorización para obtener los token necesarios para realizar llamadas autenticadas a la API. El token de acceso permite a tu aplicación recuperar datos de rendimiento, mientras que el token de actualización te permite generar nuevos token de acceso sin repetir el proceso de autorización.
Los códigos de autorización son token de un solo uso. Cuando se usan para recuperar un access_token, devuelven un refresh_token que se puede usar para recuperar el siguiente access_token. La siguiente sección te guía por la recuperación de tu primer refresh_token.
Solicitud inicial de token (solo la primera vez):
Para solicitar un token:
- Ingresa el client_id, client_secret, authorization_code, y el grant_type como datos de formulario con codificación URL.
- Haz una solicitud HTTP.
El comando curl para generar token desde el authorization_code se muestra en el siguiente ejemplo.
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'
Actualización de tu token de acceso:
Para todas las sesiones posteriores a tu solicitud inicial de token, usa tu token de actualización para obtener nuevos token de acceso: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]'
Paso 4: Configura tu aplicación
¡Felicidades! Ahora tiene todas las credenciales necesarias para llamar a las API de rendimiento. Como parte de este paso, configurarás tu aplicación para incluir tu token de acceso en el encabezado de autorización de cada solicitud de API, lo que te permitirá recuperar los datos de suscripción, las métricas de rendimiento y los análisis de tu contenido.
Ejemplo de solicitud de API:
curl --request GET \
--url https://videocentral.amazon.com/apis/v1/accounts \
--header 'authorization: bearer Atza|IwEBIPSxTCdGGC-xL-ywFib_lJfg-D7d435Jw739GWa3xy6dHJ
En este ejemplo se muestra cómo autenticar tus solicitudes: reemplaza [YOUR_ACCESS_TOKEN]
Paso 5: Integración de pruebas
Recomendamos encarecidamente a todos los socios que prueben minuciosamente su integración para garantizar un acceso fiable a los datos de rendimiento. Como parte de este paso, validarás que tu flujo de autenticación funciona correctamente, que tus llamadas a la API devuelven los datos esperados y que la gestión de errores está configurada de manera correcta.
Paso 6: Comienza a usarlo
Una vez que completes las pruebas y que valides que la integración funciona de forma confiable, puedes empezar a usar el entorno de producción para recuperar los datos de rendimiento y el análisis en tiempo real para tu contenido en Prime Video. Tus flujos de datos ahora pueden consumir los archivos de conjuntos de datos de solo adición para realizar los análisis granulares que necesita tu organización.
Puedes obtener más información sobre los marcos de datos de la API de Analytics disponibles aquí: