Ir al contenido

Colección de Postman

Si prefieres probar Colonix con clics antes de escribir código, la colección de Postman trae todas las consultas listas para enviar, cada una con una respuesta real de ejemplo y pruebas que revisan lo que regresa la API.

  • 66 peticiones en 8 carpetas: códigos postales, asentamientos, catálogos, cambios, errores, SAT, geografía y caché (ETag e If-None-Match).
  • Un ejemplo guardado en cada petición con una respuesta real de la API, para ver la forma de la respuesta sin enviar nada.
  • Pruebas automáticas (237 comprobaciones): estado, tipo de contenido, versión del dato y los campos principales de cada respuesta.
  • Qué plan pide cada una: las que no responden con la llave gratis lo dicen al inicio de su descripción.
  • Peticiones encadenadas: algunas usan datos de otras (por ejemplo, la versión del dato para revalidar o el cursor de la página siguiente), así que conviene correr la colección completa.

La colección es pública en la red de APIs de Postman. Con Abrir en Postman la ves en el navegador y con Fork te la copias a tu espacio; si al hacer el fork eliges recibir los cambios automáticamente, tu copia se actualiza cuando publiquemos una versión nueva.

Si prefieres el archivo:

  1. Descarga la colección con el botón de arriba.

  2. En Postman, elige Import y arrastra el archivo.

  3. Abre la colección, ve a Variables y pon tu llave en el valor actual (Current value) de apiKey. baseUrl ya apunta a https://colonix.silgaru.mx.

  4. Abre cualquier petición y presiona Send.

Con el Collection Runner de Postman, o desde la terminal con Newman, el ejecutor de colecciones de Postman. Primero deja tu llave en una variable de entorno sin que quede en el historial:

read -rs COLONIX_API_KEY && export COLONIX_API_KEY # pega tu llave y presiona Enter
npx --yes newman@6.2.1 run colonix.postman_collection.json --env-var "apiKey=$COLONIX_API_KEY"

Las peticiones del SAT, la consulta en lote, los cambios del catálogo y la geografía necesitan el plan que las incluye (qué incluye cada plan): con otro plan, las que no usan un código postal de demostración responden 403 y sus pruebas fallan. Con una llave de prueba, solo responden los códigos postales de demostración y los catálogos.

Postman también puede crear una colección a partir del contrato: Import → openapi.es.yaml (o openapi.yaml en inglés). Esa colección tiene todas las peticiones con sus parámetros, pero no las pruebas ni los ejemplos encadenados de la colección de arriba. El mismo contrato sirve para Insomnia, Bruno o para generar un cliente en tu lenguaje.