Rueda Lens

Comenzar

Autenticación

Aprende a autenticar tus solicitudes a la API de Rueda Lens.

Rueda Lens utiliza autenticación mediante clave de API usando tokens Bearer para un acceso seguro a la API.

Formato de la clave de API

rdlns_sk_<cadena_de_36_caracteres>
  • Prefijo: rdlns_sk_ identifica las claves secretas de Rueda Lens
  • Longitud total: 44 caracteres
  • Almacenamiento: Las claves se almacenan cifradas con bcrypt en nuestra base de datos; nunca se guardan en texto plano

Realizar solicitudes autenticadas

Incluye tu clave de API en la cabecera Authorization usando el esquema Bearer:

curl -X POST https://api.ruedalens.com/v1/analyze \
  -H "Authorization: Bearer rdlns_sk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "tireImage": "/9j/4AAQSkZJRg...",
    "carImage": "/9j/4AAQSkZJRg..."
  }'

Crear una clave de API

  1. Inicia sesión en tu panel
  2. Accede a API Keys
  3. Haz clic en Create New Key
  4. Asigna un nombre descriptivo
  5. Copia y guarda la clave de forma segura

Advertencia de seguridad

Las claves de API otorgan acceso completo a tu cuenta. Nunca las incluyas en repositorios de código ni las compartas públicamente.

Buenas prácticas

Usar variables de entorno

Guarda las claves de API en variables de entorno; nunca las incrustes directamente en el código:

RUEDA_LENS_API_KEY=rdlns_sk_your_api_key_here
const apiKey = process.env.RUEDA_LENS_API_KEY;

Rotar las claves periódicamente

La rotación periódica de claves es una buena práctica de seguridad. Así puedes hacerlo sin interrupciones del servicio:

  1. Crea una nueva clave en el panel manteniendo activa la anterior
  2. Despliega la nueva clave en tu aplicación (mediante variables de entorno o un gestor de secretos)
  3. Verifica que la nueva clave funciona realizando una solicitud de prueba
  4. Supervisa durante un periodo de gracia (por ejemplo, 24–48 horas) para asegurarte de que todos los servicios se han actualizado
  5. Revoca la clave antigua una vez confirmado que la nueva funciona en todos los entornos

Rotación sin interrupciones

Este enfoque con solapamiento garantiza la continuidad del servicio durante la rotación de claves. Ambas claves permanecen válidas durante el periodo de transición, evitando interrupciones.

Usar claves separadas por entorno

EntornoNombre de la clave
Desarrollodev-server
Stagingstaging-ci
Producciónproduction-primary

Proteger tu API con filtrado por IP

Para una mayor seguridad, recomendamos encarecidamente implementar filtrado por IP a nivel de infraestructura:

Por qué es importante el filtrado por IP:

  • Evita usos no autorizados incluso si una clave de API se ve comprometida
  • Añade una capa adicional de seguridad en profundidad
  • Ayuda a detectar y prevenir robos o filtraciones de credenciales

Formas de implementación:

  1. Filtrado a nivel de aplicación (recomendado en la mayoría de casos):

    const ALLOWED_IPS = ['203.0.113.42', '198.51.100.0/24'];
    
    function isAllowedIP(requestIP) {
      return ALLOWED_IPS.some(allowedIP => {
        // Implementa tu lógica de coincidencia de IP
        return requestIP === allowedIP || matchesCIDR(requestIP, allowedIP);
      });
    }
    
    // Comprobación antes de realizar llamadas a la API
    if (!isAllowedIP(clientIP)) {
      throw new Error('IP no autorizada');
    }
  2. Filtrado a nivel de infraestructura:

    • AWS: Usa Security Groups o reglas de WAF
    • Cloudflare: Configura reglas de acceso por IP
    • Nginx: Usa las directivas allow y deny
    • Balanceadores de carga en la nube: Configura rangos de IP de origen permitidos
  3. VPN o red privada:

    • Enruta el tráfico hacia la API a través de una VPN con IPs estáticas
    • Utiliza redes privadas del proveedor cloud (AWS PrivateLink, Azure Private Link)

Despliegue en producción

Combina siempre el filtrado por IP con la autenticación mediante clave de API. El filtrado por IP por sí solo no es suficiente, y las claves de API por sí solas son vulnerables. Utiliza ambos para una protección máxima.

Gestión de claves

En el panel puedes ver el nombre, la fecha de creación, la fecha de último uso y el prefijo de cada clave (por ejemplo, rdlns_sk_abc...xyz).

Privacidad

Por seguridad, en el panel solo se muestran los 3 primeros y los 3 últimos caracteres de cada clave.

Revocar claves

Para revocar una clave comprometida o que ya no se utilice:

  1. Accede a API Keys en tu panel
  2. Localiza la clave y haz clic en Revoke
  3. Confirma la acción

Acción irreversible

La revocación de una clave es inmediata y permanente. Todas las solicitudes que usen esa clave fallarán al instante.

Errores de autenticación

Código de estadoCódigo de errorDescripción
401MISSING_API_KEYCabecera Authorization ausente o sin esquema Bearer
401INVALID_API_KEYClave de API inválida, revocada o caducada
429RATE_LIMIT_EXCEEDEDDemasiadas solicitudes — consulta limitación de solicitudes
{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}