Guía de inicio rápido: Introducción al uso de la collection de Postman de la Amazon Ads API

La collection de Postman de la Amazon Ads API incluye scripts para facilitar la gestión de las credenciales de autenticación y autorización para llamar a la API, así como solicitudes prediseñadas para demostrar los usos comunes de la API.

Como alternativa a nuestro tutorial de introducción , muchas personas que llaman por primera vez pueden encontrar útil a Postman para comprender la API.

La configuración rápida a continuación ofrece instrucciones paso a paso para configurar la collection de Postman para realizar solicitudes a la API.

📘

Tutorial de vídeo

Los videos de demostración están integrados para cada paso a continuación. También puede ver el recorrido completo en YouTube.

Antes de empezar

Para completar esta guía, necesitará:

• El client ID y el client secret de una aplicación cliente de Login with Amazon aprobada para usar la Amazon Ads API. Consulte Inducción si aún no ha sido aprobado para el acceso.
• Credenciales de inicio de sesión para una cuenta de usuario de Amazon que administra cuentas de Amazon Ads.
• Postman, una herramienta de terceros que permite a los desarrolladores realizar llamadas API a través de una interfaz de usuario. Puedes usar el desktop o web-based.

📘

La interfaz de usuario del Postman

Los términos de los elementos de la interfaz de usuario de Postman utilizados en este documento están alineados con los utilizados por Postman. Consulte la documentación de la interfaz de Postmanpara obtener más información y ayudas visuales.

Configuración rápida

Importar la collection y los archivos de environment.

1. Descargar el archivo de environment de Postman y archivo de collection de GitHub.
2. Importa ambos archivos a Postman. Para verificar la importación:
   • Seleccione el ícono Collections en la barra lateral izquierda. Debería ver la collection Amazon Ads API .
   • Seleccione el ícono Environments en la barra lateral izquierda. Debería ver el Amazon Ads API Environment .
3. Desde el selector Environments, seleccione el Amazon Ads API Environment para activar el environment.

Configurar el Environments

1. En la barra lateral izquierda, seleccione Environments y, a continuación, seleccione el Amazon Ads API Environment .

2. Establezca manualmente el valor actual para las siguientes variables:

   Variable	Descripción
   client_id	El ID de cliente de la aplicación de cliente Login with Amazon aprobada para usar la API.
   client_secret	El secreto de cliente de la aplicación de cliente Login with Amazon aprobada para usar la API.
   redirect_uri	Una URL incluida en la configuración de "Allowed Return URLs" de su aplicación Login with Amazon. En el environment, esto está configurado https://amazon.comde forma predeterminada. Aún deberá habilitar esta URL en Login with Amazon o modificar esta variable para reflejar otra URL permitida.

    Nota

   El environment predeterminado está configurado para acceder al host norteamericano para la API. Para ver cambios adicionales para acceder a la API en otras regiones, consulte Regiones .

3. Guarde los cambios en su environment.

Generar un código de authorization grant

1. En la barra lateral izquierda de Postman, ve a Collections > Amazon Ads API .

2. Seleccione la carpeta Auth en la collection, luego busque la solicitud GETAuth grant login

3. Abra el Console en el pie de página del Postman.

4. haga clic en Send para enviar la solicitud. Esta acción prueba la URL en la ventana de vista previa de Postman y registra la URL adecuada en la consola de Postman.

5. Copie la URL de concesión de autorización desde la consola, visite la ubicación en un navegador web e inicie sesión con una cuenta de usuario de Amazon que administre cuentas de Amazon Ads.

    Importante

   Asegúrese de haber cerrado la sesión de cualquier otra cuenta de usuario de Amazon antes de visitar la URL de autorización.

6. Se le redirige al redirect_uri que configuró en su archivo de environment. Se adjunta un authorization grant code a esta URL como parámetro de consulta de code.

La dirección en la barra de URL de su navegador debe parecerse a la siguiente, donde XXXXX está el authorization grant code:

https://amazon.com/?code=XXXXX&scope=advertising%3A%3Acampaign_management

Tenga en cuenta este código para usarlo en el siguiente paso. El código de autorización representa el permiso de la cuenta de usuario para que su aplicación de cliente acceda a los servicios y datos publicitarios de esa cuenta.

 Nota

Los códigos de concesión de autorización caducan en 5 minutos. Se puede generar un nuevo código repitiendo el proceso de concesión de autorización.

Recuperar tokens de acceso y actualización

1. En la carpeta Auth de la collection, seleccione la solicitud POSTAccess token from auth gran de concesión de autenticación.
2. En el Body de esta solicitud, busque el parámetro code e ingrese el código obtenido en el paso anterior.
3. En Send envía la solicitud.

Una solicitud exitosa establece las variables access_token y refresh_token en su environment.

📘

Caducidad del token

Los tokens de acceso caducan en 60 minutos. Los tokens de actualización no caducan.

Para solicitudes posteriores a la API, una secuencia de comandos en la collection de Postman de la Amazon Ads API utiliza el token de actualización para generar nuevos tokens de acceso automáticamente según sea necesario.

Recuperar una profile ID

1. Seleccione la carpeta Profiles en la collection.
2. Seleccione la solicitud GETProfiles y en Send envía la solicitud.

La respuesta a esta solicitud es una lista de profiles , cada uno de los cuales representa la cuenta de Amazon Ads de la cuenta de usuario en un marketplace en particular.

De forma predeterminada, un script en la collection establece la variable profileId en el environment en el primer perfil devuelto en la respuesta. Este valor se utiliza en llamadas posteriores. Para obtener más información sobre los profiles, consulte Profiles .

Próximos pasos

Su environment de Postman ahora tiene las credenciales requeridas para realizar otras solicitudes a la Amazon Ads API:

• Su client ID
• Un access token
• Un profile ID

La collection de Postman está configurada para incluir estos valores en los headers de solicitudes posteriores.

Para probar una primera llamada típica a la API, consulte Realización de su primera llamada .

Apoyo técnico

Si tiene dificultades para conectarse a la Amazon Ads API, visite nuestra página de soporte técnico para obtener información.

Si cree que el problema está relacionado con esta documentación o con la collection de Postman, puede abrir un problema en nuestro repositorio de GitHub.

Cambios opcionales

Regiones

El environment proporcionado está configurado para llamar al host norteamericano para la Amazon Ads API. Para acceder a los datos y servicios publicitarios en Europa o Asia, cambie las variables api_url, auth_grant_url y token_url en el environment a los hosts regionales apropiados.

Para obtener una lista de los marketplaces en cada región, consulte API endpoints.