Documentación de API

Autenticación

Autenticación de API

Todas las solicitudes de API requieren autenticación usando una clave de API. Esta guía explica cómo crear, gestionar y usar claves de API de manera segura.

Obteniendo una Clave de API

Para obtener una clave de API, necesitas tener una cuenta de iloveQR y ser parte de una organización.

Inicia sesión en tu cuenta

Inicia sesión o crea una cuenta si no tienes una.

Navega a la página de Desarrolladores

Ve a Panel → Desarrolladores para gestionar tus claves de API.

Crea una nueva clave de API

Haz clic en 'Crear Clave de API', dale un nombre descriptivo y almacena de forma segura la clave generada.

Usando Tu Clave de API

Incluye tu clave de API en el encabezado X-API-Key con cada solicitud:

Encabezado de Solicitud

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

ID de Organización

La mayoría de los puntos finales de API requieren un ID de organización en la ruta de la URL. Puedes encontrar tu ID de organización en la configuración del panel o haciendo una solicitud al punto final de organizaciones.

Obtén Tus Organizaciones

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Respuesta

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Mejores Prácticas de Seguridad

Nunca expongas claves de API en el código del lado del cliente

Siempre haz llamadas a la API desde tu servidor. Nunca incluyas claves de API en JavaScript que se ejecute en el navegador, aplicaciones móviles o cualquier código que pueda ser visto por los usuarios.

Usa variables de entorno

Almacena tus claves de API en variables de entorno, no en tu base de código. Esto previene la exposición accidental a través del control de versiones.

Rotar claves regularmente

Crea nuevas claves de API periódicamente y revoca las antiguas. Si sospechas que una clave ha sido comprometida, revócala de inmediato.

Errores de Autenticación

Cuando la autenticación falla, la API devuelve una de estas respuestas de error:

Código de Estado	Error	Descripción
401	UNAUTHORIZED	Clave de API faltante o inválida
403	FORBIDDEN	La clave de API no tiene permiso para esta acción
403	API_KEY_REVOKED	La clave de API ha sido revocada

Ejemplo de Respuesta de Error

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Próximos Pasos

Ahora que entiendes la autenticación, aprende cómo usar la API: