Colección de Postman

Postman es una herramienta que permite centralizar colecciones, entornos, ejemplos y flujos de prueba de APIs en una sola plataforma.​ Esto facilita a los desarrolladores la integración de APIs sin necesidad de crear un request desde cero. En ProntoPaga, contamos con una colección de Postman que incluye todos los endpoints para que puedas validar las integraciones, depurar request y responses, y explorar los flujos completos de la API, ya sea con credenciales propias o con credenciales de sandbox.

---

¿Qué incluye la colección?

En nuestra colección de Postman podrás encontrar:

• Todos los endpoints organizados por producto.
• Scripts de firma automátca (Pre-request).
• Configuración de autenticación incluida.
• Credenciales de sandbox para pruebas.
• Ejemplos listos para ejecutar.

---

Primeros pasos

Antes de iniciar, necesitas descargar la aplicación de Postman.

1. Ingresa al sitio oficial de Postman desde tu navegador preferido.
2. Selecciona la versión de tu sistema operativo y haz clic en el botón correspondiente: Windows, macOS o Linux.

3. Una vez descargado el archivo, dependiendo de tu sistema operativo, sigue estos pasos:

4. Una vez instalado, debes iniciar sesión o crear una cuenta para acceder a tu workspace, el cual lucirá similar a este:

5. Ingresa a la colección de Postman de ProntoPaga y sigue la ruta COLLECTIONS > ProntoPaga API > botón de los tres puntos > more > Export collection. Se descargará un archivo JSON.

6. En tu aplicación de Postman, dirígete a los tres puntos de la parte superior izquierda, y selecciona Import.

7. Selecciona el archivo JSON descargado. ¡Listo! Ahora tienes acceso a la colección completa de Postman de ProntoPaga.

---

Crear tu primer request

Antes de empezar, ten en cuenta lo siguiente:

• Para sandbox, contamos con credenciales de prueba. En el caso del Bearer Token es el siguiente:

  caff446438560a48438e0b49e5a6a0870ac5624b9f9ce1577858595d1a8ba1ec

• Además, contamos con una secretKey de prueba:

  01JNH2SBC5Z2CM1PWQXM2C1XK9

📘

Tipos de credenciales

En caso de contar con credenciales propias de sandbox o de producción, ingrésalas en los campos correspondientes para crear tu request, según requieras.

Una vez te encuentres en la colección ProntoPaga API de tu aplicación web de Postman, sigue estos pasos:

1. Selecciona el endpoint que desees probar. Para este ejemplo, utilizaremos el endpoint de crear un nuevo pago con Paga Con Tu Banco - Chile.

2. Dirígete a la pestaña Authorization, selecciona Bearer Token de la lista Auth Type, e ingresa el Bearer Token de prueba.

3. Dirígete a la pestaña Scripts y selecciona la opción Pre-request, donde deberás colocar la secretKey de prueba:

4. En la sección Body, modifica el contenido del parámetro order por un número aleatorio. Este parámetro también debe ser cambiado en el body del Pre-request.

📘

Request productivo

En caso de realizar un request con datos productivos, debes modificar los parámetros con información verídica. Ten en cuenta que estarás operando con transacciones reales y datos en vivo.

5. Haz clic en el botón Send.

6. En la parte inferior de la pantalla aparecerá la respuesta exitosa.

---

Buenas prácticas

---

Firma de las transacciones

Algunos endpoints requieren una firma para validar la integridad del request.

La colección de Postman incluye un script en Pre-request que:

• Genera la firma automáticamente
• Inserta los headers necesarios
• Utilizar la secretKey configurada

No es necesario implementar manualmente la firma dentro de Postman. Conoce más acerca de la firma de transacciones.

---

Webhooks

Configurar un webhook para tus transacciones te ayudará a conocer el estado de los pagos y retiros. Estos callbacks te notificarán cuando se produzca un cambio de estado en una determinada transacción. Conoce cómo crear uno en este artículo.