Esta es una Guía Rápida para conocer la plataforma y acomodo de la Documentación Técnica de ProntoPaga. Nuestra documentación cuenta con cuatro pestañas principales en el menú superior:
A continuación, te mostramos qué puedes encontrar en cada una, así como consejos para sacar lo mejor de esta documentación.
Guides
La pestaña de Guides contiene principalmente todas las Guías de integración, ordenadas por país y métodos. Además, también contiene información general que puede ser de utilidad para tu integración. En la siguiente imagen puedes observar sus características:
Dentro de cada Guía de integración podrás encontrar información detallada, como:
- Introducción al método
- Notas o especificaciones importantes
- Ejemplos de body request para la solicitud
- Ejemplos de posibles respuestas
- Ejemplos de webhooks
Recipes
En la pestaña de Recipes encontrarás tutoriales cortos para resolver preguntas comunes. Estas recetas están también mencionadas y linkeadas en el endpoint o guía correspondiente.
API Reference
La pestaña de API Reference es la más visitada de nuestro sitio. Aquí encontrarás todos los endpoints de ProntoPaga, ordenados por método. A continuación te mostramos los componentes generales:
Además, cada endpoint cuenta con ejemplos de body request y respuestas, así como un ambiente listo para realizar pruebas de la API en vivo:
Recuerda que para hacer uso de la caja de pruebas en vivo, deberás contar con tu Bearer Token y SecretKey de sandbox (proporcionados por ProntoPaga), y seguir estos pasos:
- Agregar tu Bearer Token en la sección Credentials
- Modificar los valores de los parámetros del body (en caso de ser necesario)
- Crear la firma de la transacción con tu SecretKey y agregarla al body de la transacción (en caso de ser necesario)
- Hacer clic en el botón Try it!
Colección de Postman
Si prefieres realizar tus pruebas desde Postman, tenemos a tu disposición una colección que puedes copiar en tu espacio de trabajo.
Changelog
La pestaña de Changelog contiene el detalle del control de cambios de la API. Podrás ver los cambios realizados en cada nueva versión.