Ir al contenido principal

Cómo utilizar la API de Ezus

La guía para realizar tu primera solicitud autenticada.

Escrito por Nataly Montelongo

1. Primeros pasos

La API de Ezus le permite leer y escribir sus datos de Ezus (proyectos, clientes, proveedores, productos, pasos…) desde sus propias herramientas.

Para comenzar a utilizar la API EZUS, necesita:

  • Una cuenta EZUS Premium o Empresa activa

  • Una clave API

  • Un Bearer Token

Nuestra documentación técnica proporciona información detallada sobre todos los puntos finales disponibles, los parámetros y los ejemplos de solicitud. ​

👾 Documentación de la API EZUS: https://api.ezus.io/

💡 La API está disponible exclusivamente con el plan Premium y Empresa.

2. Obtener su clave API

La mayoría de rutas requieren una clave API para la autenticación. Puede encontrar su clave API directamente desde su espacio de trabajo de Ezus. ​

Vaya a Configuración > Desarrolladores desde https://pro.ezus.io/settings

🚨 Una clave API es privada y debe mantenerse confidencial. Tenga cuidado de quién tiene acceso y dónde se almacena.

3. Entender los puntos finales y los métodos

Estudie los endpoints (URLs) con los que puede interactuar y el método HTTP necesario para cada uno:

GET — recuperar información

POST — agregar o modificar información

PUT / PATCH — modificar datos existentes

Webhooks — desencadenar una acción en un evento específico​

4. Autenticación

La API EZUS utiliza un proceso de autenticación seguro de dos pasos.

1. Clave API

Incluya su clave API en el encabezado de cada solicitud: ​

x-api-key: YOUR_API_KEY

Identifica su integración. Es estática, se crea una vez en su configuración y se envía con cada solicitud.

2. Bearer Token

Autentique su usuario llamando al endpoint /login. ​

Recibirá un Bearer Token válido durante 12 horas, que debe incluirse en las solicitudes que requieren autenticación: ​

Authorization: Bearer YOUR_TOKEN

Cuando su token expire, simplemente solicite uno nuevo llamando al endpoint /login nuevamente. ​ ​

ℹ️ ¿Qué es un Bearer Token?

Un Bearer Token es un token de seguridad temporal que prueba su identidad a la API EZUS.

Después de iniciar sesión a través del endpoint /login usando sus credenciales de EZUS, la API devuelve un Bearer Token. Este token debe incluirse en el encabezado Authorization de sus solicitudes: ​

Authorization: Bearer YOUR_TOKEN

El servidor verifica que el token sea válido antes de otorgar acceso a sus datos.

¿Por qué utilizar un Bearer Token? Este método de autenticación ofrece varias ventajas:

  • Seguridad mejorada: su contraseña nunca se envía con cada solicitud.

  • Vida útil limitada: el token expira automáticamente después de 12 horas, reduciendo los riesgos de seguridad si se ve comprometido.

  • Mejor rendimiento: una vez autenticado, puede realizar varias solicitudes de API sin iniciar sesión nuevamente.

Cuando su Bearer Token expire, simplemente llame al endpoint /login para obtener uno nuevo. ​ ​

Piénselo como un edificio: la x-api-key es su distintivo para entrar al edificio, y el Bearer Token es la clave de las salas adentro. Necesita ambos. ​

El flujo completo se ve así:

Configuración → API → copiar su x-api-key

POST /login (+ x-api-key) → recibir un Bearer Token (válido 12h) Cualquier solicitud (+ ambos) → acceder a sus datos

¿Token expirado? → llamar a /login nuevamente para obtener uno nuevo

Puede enviar sus solicitudes utilizando una herramienta como Postman o un lenguaje de programación como Python. Incluya su clave API en los encabezados de la solicitud según lo requiere la documentación. ​

Para obtener más información sobre Postman, consulta nuestro artículo ✍️ Use Postman para sus llamadas en la API de Ezus

Inicie sesión para obtener un Bearer Token Llame al punto final /login con su clave API y sus credenciales de Ezus. Recibirá un Bearer Token válido durante 12 horas.

curl -X POST https://api.ezus.io/login \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]","password": "YOUR_EZUS_PASSWORD"}'

Respuesta de ejemplo:

{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6..." }

Copie el token devuelto — lo pasará como su Bearer Token en el siguiente paso.

5. Generar las respuestas

Cada solicitud que accede a sus datos debe incluir ambos encabezados: su clave API y su Bearer Token.

curl -X GET https://api.ezus.io/projects \
-H "x-api-key: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_TOKEN"

Elija el método correcto para lo que desea hacer: ​

GET — Recuperar información (p. ej. listar sus proyectos)

POST — Crear nuevos datos (p. ej. un nuevo proyecto o proveedor)

PUT / PATCH — Modificar datos existentes

Webhooks — Desencadenar una acción en un evento específico (p. ej. se crea un proyecto) ​

La URL exacta para cada acción (su « ruta »), los parámetros que acepta y los datos que devuelve se enumeran en la documentación de la API: https://api.ezus.io/

Las respuestas se devuelven en JSON. Analice la respuesta y extraiga los campos que su aplicación necesita. ​ Una respuesta de lista típica se ve así:

{
"data": [ { "reference": "PRJ-001", "title": "Peru Discovery", "budget": 4200 }, { "reference": "PRJ-002", "title": "Iceland Roadtrip", "budget": 3100 } ]
}

💡 Siempre verifique el código de estado HTTP antes de analizar: 2xx significa éxito, 4xx significa que hay un problema con su solicitud.


Solución de problemas

  • Errores de autenticación

Si recibe un error 401 Unauthorized o 403 Forbidden, verifique que:

  • su clave API (x-api-key) sea válida;

  • su Bearer Token no haya expirado (válido durante 12 horas);

  • ambos encabezados de autenticación se incluyan cuando sea necesario.

Si es necesario, genere un nuevo token a través del endpoint /login. ​

  • Limitación de velocidad

Para garantizar la estabilidad de la plataforma, la API EZUS aplica limitación de velocidad.

Si recibe un error 429 Too Many Requests, reduzca la frecuencia de sus solicitudes o implemente un reintento con retroceso exponencial antes de intentar nuevamente. ​

¿Ha quedado contestada tu pregunta?