Documentación de la API
Esta página utiliza el mismo modelo de carga que el generador de la página principal y envía solicitudes a https://qrkit.io/api/v1/qr/generate para que puedas probar el comportamiento de extremo a extremo en un solo lugar.
Tipos compatibles
Campos para URL
| Campo | Tipo | Requerido |
|---|---|---|
| url | url | sí |
Ejemplo cURL
curl -X POST https://qrkit.io/api/v1/qr/generate \
-H "Content-Type: application/json" \
-d '{"type":"url","payload":{"url":"https://www.example.com"},"design":{"frame":{"enabled":false,"type":"none","text":"","fontFamily":"sans-serif","fontSize":34,"fontWeight":700,"textColor":"#ffffff","backgroundColor":"#000000","qrPadding":24,"paddingX":16,"paddingY":10,"borderRadius":12},"modules":{"shape":"square","color":"#000000","gradient":null},"background":{"color":"#ffffff","transparent":false},"finder":{"style":"square","centerStyle":"square","outerColor":"#000000","innerColor":"#000000","borderColor":"#000000"},"logo":{"enabled":false,"assetId":null,"sizePercent":20,"padding":0,"backgroundColor":"#ffffff","shape":"square","removeBackgroundBehindLogo":true},"quietZone":{"modules":2,"size":16}},"format":"svg","size":512,"errorCorrection":"M"}'Probar la API de generación
Cargando...
Claves JSON de diseño compatibles
El ejemplo de diseño predeterminado ahora incluye la estructura completa del objeto. Usa la referencia de abajo para entender qué claves anidadas puedes sobrescribir en `design`.
| Campo | Tipo | Ejemplo | Valores permitidos | Qué cambia |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | Muestra un marco con CTA alrededor del código. |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | Selecciona el preset del marco CTA. |
| frame.text | string | "SCAN ME" | - | Etiqueta CTA renderizada dentro del marco. |
| frame.fontFamily | string | "Space Grotesk" | - | Familia tipográfica usada para el texto CTA. |
| frame.fontSize | number | 34 | - | Controla la escala del texto CTA. |
| frame.fontWeight | number | 800 | - | Controla el grosor del texto CTA. |
| frame.backgroundColor | string | "#0f172a" | - | Color de relleno del marco. |
| frame.textColor | string | "#ffffff" | - | Color del texto CTA. |
| frame.qrPadding | number | 24 | - | Espacio entre el cuerpo QR y el marco exterior. |
| frame.paddingX | number | 16 | - | Relleno horizontal dentro del marco CTA. |
| frame.paddingY | number | 12 | - | Relleno vertical dentro del marco CTA. |
| frame.borderRadius | number | 12 | - | Redondeo de las esquinas del marco. |
| Campo | Tipo | Ejemplo | Valores permitidos | Qué cambia |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | Define la forma de los módulos QR. |
| modules.color | string | "#111827" | - | Color principal de los módulos. |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | Gradiente opcional de los módulos. |
| modules.gradient.from | string | "#111827" | - | Color inicial del gradiente. |
| modules.gradient.to | string | "#10b981" | - | Color final del gradiente. |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | Dirección del gradiente a través de los módulos QR. |
| background.color | string | "#ffffff" | - | Color de fondo del lienzo. |
| background.transparent | boolean | false | - | Hace transparente el fondo. |
| Campo | Tipo | Ejemplo | Valores permitidos | Qué cambia |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | Forma del finder exterior. |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | Forma del centro del finder. |
| finder.outerColor | string | "#111827" | - | Color del anillo exterior del finder. |
| finder.innerColor | string | "#0ea5e9" | - | Color del centro del finder. |
| finder.borderColor | string | "#111827" | - | Color de acento del borde del finder. |
| quietZone.size | number | 24 | - | Espaciado de la zona de silencio alrededor del QR. |
| quietZone.modules | number | 4 | - | Control del espaciado basado en módulos. |
| Campo | Tipo | Ejemplo | Valores permitidos | Qué cambia |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | Activa el renderizado del logo. |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | Referencia un asset de logo subido mediante su ID. |
| logo.sizePercent | number | 18 | - | Tamaño del logo relativo al cuerpo del QR. |
| logo.padding | number | 6 | - | Espacio adicional alrededor del logo. |
| logo.shape | string | "circle" | circle, square | Elige la forma de máscara del logo. |
| logo.backgroundColor | string | "#ffffff" | - | Fondo debajo del logo. |
| logo.removeBackgroundBehindLogo | boolean | true | - | Elimina los módulos QR detrás del logo. |
| logoDataUrl | string | "data:image/png;base64,..." | - | Data URL inline PNG/JPG/SVG para renderizar el logo directamente. |