Lineamientos de la API de Postman

Postman mejora significativamente la capacidad de probar y comprender las APIs de Merchant Center, ya que proporciona una interfaz fácil de usar para construir, enviar y analizar solicitudes HTTP. Puedes crear y modificar fácilmente varias llamadas a la API (GET, POST, PUT, DELETE) a diferentes endpoints, y ajustar parámetros, encabezados y cuerpos de solicitudes para simular situaciones del mundo real.

La presentación clara de las respuestas de la herramienta, incluidos los códigos de estado, los encabezados y las cargas útiles, permite verificar rápidamente el comportamiento de la API y ayuda a depurar problemas. Este enfoque estructurado acelera el ciclo de vida del desarrollo, mejora la calidad de la API y profundiza la comprensión de las capacidades y complejidades de la API de Merchant.

Descripción general

Para usar la colección de MAPI de Postman en tu instancia de Postman, primero debes seguir algunos pasos para configurar el entorno. Aquí encontrarás una guía paso a paso para hacerlo.

Para obtener más información sobre la plataforma, consulta la descripción de Postman.

1. Configuración de la cuenta de servicio

Obtendrás serviceAccountKey y api_key.

  1. Para obtener instrucciones detalladas, consulta cómo usar una cuenta de servicio para acceder a la API.
  2. En tu proyecto de Google Cloud > Credenciales > Crear credenciales > Cuenta de servicio
  3. Completa el formulario y haz clic en Crear y continuar.
  4. Selecciona el rol Propietario y haz clic en Continuar.
  5. Haga clic en Listo
  6. Para descargar la clave JSON, sigue estos pasos:
    1. Haz clic en el correo electrónico de la cuenta de servicio que acabas de crear (algo como {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Haz clic en la pestaña Claves.
    3. Haz clic en Agregar clave > Crear clave.
    4. Selecciona JSON y haz clic en Crear para descargar el archivo JSON.

ADVERTENCIA: Solo puedes descargar la clave una vez. Si la pierdes, deberás crear una nueva y borrar esta.

  1. Abrir Merchant Center
  2. En Configuración > Acceso y servicios, haz clic en Personas y acceso.
  3. Haz clic en Agregar persona y usa el ID de la cuenta de servicio como la dirección de correo electrónico del usuario nuevo.

2. Configuración de Postman

  1. Descarga la plantilla JSON del entorno de Postman.
  2. Descarga el archivo JSON de la colección de Postman de la MAPI
  3. Accede a Postman o crea una cuenta nueva
  4. Importa la plantilla del entorno de Postman.
    1. Copia tu JSON completo en Environment > MyAccount > serviceAccountKey.
    2. Copia tu private_key del archivo JSON en la colección Environment > MyAccount > api_key.
  5. Cómo importar el JSON de la colección de Postman de la MAPI
  6. Selecciona el entorno en la esquina superior derecha.

3. Registro de desarrollador

Registrarte como desarrollador para vincular tu cuenta de Merchant Center al proyecto de Google Cloud Los usuarios con el rol de desarrollador de la API recibirán comunicaciones sobre la API, incluidos los anuncios obligatorios del servicio, las encuestas para desarrolladores y las oportunidades.

  1. Abre Postman > Collections > Merchant API Official.
  2. Abre accounts_v1 > accounts > accounts.developerRegistration > registerGcp.
  3. Reemplaza el marcador de posición {account} en la ruta de acceso por tu ID de MC.
  4. Reemplaza el marcador de posición {email} en el cuerpo del mensaje por tu dirección de correo electrónico.
  5. Haz clic en Enviar para ejecutar el registro.
  6. Si todo se hizo correctamente, recibirás una respuesta JSON de confirmación como la siguiente: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Prueba la API de Merchant en Postman

  1. Abre Postman > Collections > Merchant API Official > accounts_v1 > accounts > list.
  2. Haga clic en Enviar.
  3. Si todo se hizo correctamente, recibirás una respuesta JSON de confirmación como la siguiente: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }