OpenAPI y Postman

La especificación OpenAPI 3.1 está disponible en esta URL pública:

El documento incluye el servidor de producción, los métodos de autenticación, las reglas de validación, los esquemas de respuesta por endpoint, los errores, las cabeceras de límites y los ejemplos de las API disponibles. Los nombres de campos, las rutas y los ejemplos JSON son los mismos en todos los idiomas.

Importar todas las solicitudes en Postman

1. Descarga la colección completa.
2. Abre Postman y selecciona Import para importar el archivo. También puedes pegar la URL de OpenAPI en Import → Link.
3. Crea una clave API si todavía no tienes una.
4. Configura la variable apiKey de la colección con tu clave. Las solicitudes heredan la autenticación X-API-Key.
5. Elige un endpoint, revisa su cuerpo JSON y envía la solicitud. Comprueba el estado HTTP y conserva request_id.

Utiliza el almacenamiento local o seguro de Postman para tus credenciales. No publiques una colección o un entorno exportado que contenga tu clave real.

Importar un solo endpoint

Cada página de referencia incluye una acción para descargar la colección de ese endpoint. Es útil si quieres probar una consulta concreta sin importar todo el catálogo. La página también explica los parámetros, los campos de respuesta y la forma de invocar el endpoint desde curl, Node.js o Python.

Generar un cliente

Puedes importar la especificación en herramientas compatibles con OpenAPI 3.1, como generadores de clientes, validadores, herramientas de pruebas y RapidAPI. Comprueba que la herramienta soporte esta versión: un importador limitado a OpenAPI 3.0 puede interpretar los esquemas de forma distinta.

La especificación es el contrato legible por máquinas. Tras actualizar un cliente generado, revisa los cambios del esquema y ejecuta tus pruebas de integración antes de desplegarlo. Mantén la clave en una variable de entorno del servidor, no en el código generado.

Continúa con Autenticación, Errores y límites o el catálogo de API.