Documentación de la API
Referencia Completa de Parámetros
1. Comando create-qr-code
1.1 Información General
El comando create-qr-code permite crear códigos QR mediante nuestra API. También puedes integrarlo en tu propia aplicación web.
Endpoint: /api/v1/create-qr-code/ - método GET
1.2 Guía de Inicio Rápido
Envía una petición GET en el siguiente formato para obtener un código QR en PNG:
/api/v1/create-qr-code/?data=[texte-encodé-URL]&size=[pixels]
Integra un código QR en tus documentos HTML con la etiqueta <img>:
<img src="/api/v1/create-qr-code/?data=HelloWorld!&size=10"/>
La API acepta texto codificado en UTF-8.
1.3 Parámetros
Añade parámetros con &[nombre]=[valor].
data
- requerido
- Descripción
- El texto a integrar en el código QR (codificado en URL).
- Mín. caracteres
- 1
- Máx. caracteres
- ~900 (depende del nivel ECC)
- Mejor práctica
- Cuanto más corto, mejor. Usa un acortador de URL para URLs largas.
size
- opcional
- Formato
- [entero]
- Mín.
- 1
- Máx.
- 50
- Por defecto
- 10
- Ejemplos válidos
- 12, 42
- Ejemplos inválidos
- 20x20 (formato inválido), 0 (demasiado pequeño), 64 (demasiado grande)
ecc
- opcional
- Valores
- L (bajo ~7%), M (medio ~15%), Q (calidad ~25%), H (alto ~30%)
- Por defecto
- L
- Mejor práctica
- L para uso general - los lectores antiguos causan más problemas que los códigos QR dañados.
color
- opcional
- Formato
- Hexadecimal 6 caracteres [a-fA-F0-9]
- Ejemplos válidos
- FF0000 (rojo), 0000ff (azul), 556B2F (verde oliva)
- Ejemplos inválidos
- GG00AA (carácter inválido), 4ff0a (falta un char)
- Por defecto
- 000000 (negro)
- Mejor práctica
- Color lo más oscuro posible comparado con el fondo.
bgcolor
- opcional
- Formato
- Hexadecimal 6 caracteres [a-fA-F0-9]
- Ejemplos válidos
- FF0000 (rojo), 0000ff (azul), 556B2F (verde oliva)
- Ejemplos inválidos
- GG00AA (carácter inválido), 4ff0a (falta un char)
- Por defecto
- ffffff (blanco)
- Mejor práctica
- Color lo más claro posible comparado con los píxeles.
margin
- opcional
- Formato
- [entero]
- Mín.
- 0
- Máx.
- 20
- Por defecto
- 1
- Ejemplos válidos
- 1, 12
- Ejemplos inválidos
- -1 (negativo), 1487 (demasiado grande), a (no es un número)
logo
- opcional
- Formato
- [url] de una imagen PNG o JPG
- Nota
- Se recomienda usar ECC M, Q o H ya que la imagen cubre parte del código QR.
- Ejemplos inválidos
- image.png (no es una URL), favicon.ico (formato no soportado)
style
- opcional
- Valores
- square, rounded, circle, gapped, vertical, horizontal
- Por defecto
- square
- Descripción
- Forma de los módulos (píxeles) del código QR.
- Nota
- Solo PNG - ignorado en SVG.
format
- opcional
- Valores
- png, svg
- Por defecto
- png
- Descripción
- Formato de salida del código QR.
- Nota SVG
- En modo SVG, los parámetros size, style y logo son ignorados.
watermark
- opcional
- Formato
- [texto]
- Máx. caracteres
- 100
- Descripción
- Texto a mostrar debajo del código QR.
- Nota
- Solo PNG - ignorado en SVG.
- Mejor práctica
- Añade tu URL o nombre de dominio para identificar el origen del código QR.
2. Comando create-totp-qr-code
El comando create-totp-qr-code genera un código QR en formato otpauth://totp/ para autenticación de dos factores (2FA).
Endpoint: /api/v1/create-totp-qr-code/ - método GET
Los parámetros de código QR (size, ecc, color, bgcolor, margin, logo, style, watermark) son idénticos a los de create-qr-code.
2.1 Parámetros TOTP
issuer
- requerido
- Descripción
- Nombre del servicio / emisor (ej.: MiServicio, GitHub).
account
- requerido
- Descripción
- Identificador de cuenta (ej.: usuario@example.com).
secret
- requerido
- Formato
- Clave secreta codificada en base32 (ej.: JBSWY3DPEHPK3PXP).
algorithm
- opcional
- Valores
- SHA1, SHA256, SHA512
- Por defecto
- SHA1
digits
- opcional
- Valores
- 6, 8
- Por defecto
- 6
period
- opcional
- Formato
- [entero] en segundos
- Por defecto
- 30