Autenticación
Aprende a autenticarte con la API de KipuDev usando tu API Key.
Autenticación
Todas las solicitudes a la API de KipuDev requieren autenticación mediante una API Key.
Obteniendo tu API Key
- Crea una cuenta en kipudev.com
- Accede al dashboard y genera una nueva API Key
- Copia tu key y guárdala de forma segura
Importante
Tu API Key solo se muestra una vez al momento de crearla. Si la pierdes, deberás generar una nueva.
Usando tu API Key
Incluye tu API Key en el header X-API-KEY de cada solicitud:
curl -X GET "https://api.kipudev.com/api/contribuyentes/20131312955" \
-H "X-API-KEY: kipudev_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Ejemplo en JavaScript
const API_KEY = process.env.KIPUDEV_API_KEY;
async function consultarRuc(ruc: string) {
const response = await fetch(
`https://api.kipudev.com/api/contribuyentes/${ruc}`,
{
headers: {
"X-API-KEY": API_KEY,
},
}
);
if (!response.ok) {
throw new Error(`Error: ${response.status}`);
}
return response.json();
}
Ejemplo en Python
import os
import requests
API_KEY = os.environ.get("KIPUDEV_API_KEY")
def consultar_ruc(ruc: str):
response = requests.get(
f"https://api.kipudev.com/api/contribuyentes/{ruc}",
headers={"X-API-KEY": API_KEY}
)
response.raise_for_status()
return response.json()
Seguridad
Nunca expongas tu API Key en código del lado del cliente (frontend). Siempre realiza las llamadas a la API desde tu backend.
Buenas prácticas
- ✅ Usa variables de entorno para almacenar tu API Key
- ✅ Realiza llamadas a la API solo desde tu servidor backend
- ✅ Rota tus keys periódicamente
- ✅ Usa diferentes keys para desarrollo y producción
- ❌ No hardcodees la key en tu código fuente
- ❌ No compartas tu key en repositorios públicos
- ❌ No la expongas en logs o mensajes de error
Formato de API Key
Las API Keys de KipuDev tienen el siguiente formato:
kipudev_[entorno]_[32 caracteres alfanuméricos]
| Prefijo | Descripción |
|---|---|
kipudev_live_ | Key de producción |
kipudev_test_ | Key de pruebas (sandbox) |
Errores de autenticación
| Código | Mensaje | Descripción |
|---|---|---|
| 401 | API Key requerida | No enviaste el header X-API-KEY |
| 401 | API Key inválida | La key no existe o está desactivada |
| 403 | Límite diario excedido | Has superado tu cuota de consultas |
| 403 | API Key expirada | Tu key ha expirado |
{
"error": "API Key inválida",
"code": "INVALID_API_KEY"
}
Próximos pasos
- Consulta RUC - Tu primer endpoint
- Rate Limiting - Entiende los límites de tu plan