Postman
Una colección lista para importar, con todos los endpoints publicados, sus ejemplos y sus pruebas. Es segura por defecto: nada que cree, cambie, borre, envíe, llame o cobre se ejecuta solo.
Descarga
Los archivos en español y en inglés describen exactamente lo mismo; solo cambian las descripciones.
Para empezar
- Descarga la colección y el entorno con los botones de arriba.
- En Postman, pulsa Import y arrastra los dos archivos.
- Arriba a la derecha, elige el entorno «Hablame · Producción».
- Abre el entorno y pega tu clave de API en la variable
apiKey. Es secreta y viene vacía; nunca la pegues dentro de la colección. - Abre «Ping» en la carpeta «Utilidades» y envíala. Si responde 200, tu clave funciona.
Variables del entorno
Hablame · Producción
| Variable | Qué es | Valor inicial |
|---|---|---|
baseUrl | La dirección de la API. No la cambies. | https: |
apiKey | Tu clave de API. Es secreta. | (vacía) |
confirmoEfectos | Ponla en si para permitir las peticiones que crean, modifican, borran, envían, llaman o cobran. | no |
confirmoFlujos | Ponla en si para permitir la carpeta de flujos, que encadena peticiones con efectos. | no |
Nada se ejecuta solo
Antes de salir, cada petición que crea, modifica, borra, envía, llama o cobra comprueba que confirmoEfectos valga si en el entorno. Si no, se salta sola y la consola de Postman te dice por qué. Esto incluye el Runner: puedes correr la colección entera y solo se enviarán las consultas.
Cuando quieras ejecutar una de esas peticiones, cambia confirmoEfectos a si, envíala y devuélvela a no. Todo lo que envíes es real y puede cobrarse.
Estas son las peticiones que se saltan solas:
| Petición | Qué hace | Cobro |
|---|---|---|
| Crear un enlace corto | Crea datos en tu organización. | La llamada se cobra |
| Crear enlaces cortos en lote | Crea datos en tu organización. | La llamada se cobra |
| Actualizar un enlace corto | Modifica datos de tu organización. | No se cobra la llamada |
| Eliminar un enlace corto | Borra datos de tu organización. | No se cobra la llamada |
| Restaurar un enlace eliminado | Modifica datos de tu organización. | No se cobra la llamada |
La carpeta «Flujos: modifican datos y cobran» encadena crear, consultar, ver las estadísticas y borrar un enlace corto. Necesita confirmoFlujos en si y, si un paso falla, se detiene.
Qué comprueban las pruebas
Cada petición trae pruebas que solo comprueban la respuesta: que el estado sea el esperado, que llegue en JSON dentro de la envoltura de la API y que traiga el identificador de la solicitud (meta. y la cabecera X-Request-Id). No envían otras peticiones ni cambian nada.
Usa una versión actual de Postman
El salto automático usa la función pm. de Postman. Si tu versión no la tiene, actualiza Postman antes de ejecutar nada.
Siempre al día
La colección se genera con el mismo catálogo que la Referencia cada vez que se publica el sitio, así que no puede quedar distinta de la documentación.
Si algo no funciona como esperas, escríbenos a developers@hablame.co con el nombre de la petición y el identificador de la solicitud (requestId).