Skip to main content
La colección de Postman reúne los endpoints consumibles por API key ya organizados por dominio, con los mismos grupos de la Referencia de la API, listos para probar con su API key. Usa las convenciones descritas en Autenticación: autenticación por Bearer Token y base https://api.nuvia.ai. La colección se genera a partir de la misma especificación que alimenta la Referencia, así que ambas muestran exactamente la misma superficie.

Descargar la colección

Descargar colección de Postman (.zip)

Archivo .zip con la colección en formato Postman v2.1. Descomprima para obtener el nuvia-postman-collection.json.
La descarga es un .zip. Descomprímalo antes de importar. Dentro hay un único archivo, nuvia-postman-collection.json, que es la colección en sí.

Importar en Postman

1

Descomprima el archivo

Extraiga el .zip descargado. Obtendrá el archivo nuvia-postman-collection.json.
2

Importe en Postman

En Postman, haga clic en Import (esquina superior izquierda) y seleccione el nuvia-postman-collection.json. La colección Nuvia API aparece en la barra lateral, con los endpoints agrupados por dominio: Agentes, Contactos, Conversaciones, Mensajes, Inboxes, Campañas, Inscripciones en Campaña, Tablas y Listas, Base de Conocimiento y Webhooks.
3

Configure las variables

La colección usa dos variables. Abra la colección Nuvia API, vaya a la pestaña Variables y complete:Guarde. Vea cómo generar una clave en la Guía de API key.
4

Haga la primera llamada

Elija cualquier solicitud de lectura (por ejemplo, listar agentes) y haga clic en Send. La autenticación ya está configurada en la colección. Cada solicitud hereda el Bearer Token con su NUVIA_API_KEY.

Cómo está configurada la autenticación

La colección define la autenticación a nivel de la colección: el tipo es Bearer Token y el token es la variable {{NUVIA_API_KEY}}. Todas las solicitudes heredan esta configuración, así que no necesita completar el header Authorization en cada una: basta con definir la variable NUVIA_API_KEY una vez.
La colección cubre solo lo que una API key puede llamar. El flujo de inicio de sesión de la plataforma y la gestión de claves (/v1/api-keys) requieren el token de usuario y quedan fuera. Consulte la Guía de API key para crear y revocar claves.
Algunas solicitudes traen el header x-company-id deshabilitado. Solo es necesario para API keys globales de uso interno; con una clave de empresa, déjelo como está.
La NUVIA_API_KEY es una credencial sensible. No comparta la colección con el valor de la variable completado, y prefiera usar una variable de entorno de Postman en vez de guardar el valor directo en la colección.

Próximos pasos

Autenticación

Cómo autenticar sus llamadas con una API key.

Ejemplos de integración

Casos de uso completos con cURL, JavaScript y Python.