Documentação da API
Esta página usa o mesmo modelo de payload que o gerador da página inicial e envia solicitações para https://qrkit.io/api/v1/qr/generate para que você possa testar o comportamento de ponta a ponta em um só lugar.
Tipos suportados
Campos para URL
| Campo | Tipo | Obrigatório |
|---|---|---|
| url | url | sim |
Exemplo 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"}'Experimentar a API de geração
Carregando...
Chaves JSON de design suportadas
O exemplo de design padrão agora inclui a estrutura completa do objeto. Use a referência abaixo para entender quais chaves aninhadas você pode sobrescrever em `design`.
| Campo | Tipo | Exemplo | Valores permitidos | O que muda |
|---|---|---|---|---|
| frame.enabled | boolean | true | - | Mostra uma moldura de CTA ao redor do código. |
| frame.type | string | "poster" | banner, outline, bag, clapper, phone, clip, poster, classic, badge, orbit, none | Seleciona o preset da moldura CTA. |
| frame.text | string | "SCAN ME" | - | Rótulo de CTA renderizado dentro da moldura. |
| frame.fontFamily | string | "Space Grotesk" | - | Família de fonte usada para o texto do CTA. |
| frame.fontSize | number | 34 | - | Controla a escala do texto do CTA. |
| frame.fontWeight | number | 800 | - | Controla o peso do texto do CTA. |
| frame.backgroundColor | string | "#0f172a" | - | Cor de preenchimento da moldura. |
| frame.textColor | string | "#ffffff" | - | Cor do texto do CTA. |
| frame.qrPadding | number | 24 | - | Espaço entre o corpo do QR e a moldura ao redor. |
| frame.paddingX | number | 16 | - | Padding horizontal dentro da moldura CTA. |
| frame.paddingY | number | 12 | - | Padding vertical dentro da moldura CTA. |
| frame.borderRadius | number | 12 | - | Arredondamento dos cantos da moldura. |
| Campo | Tipo | Exemplo | Valores permitidos | O que muda |
|---|---|---|---|---|
| modules.shape | string | "dots" | square, rounded, dots, morse, diamond, organic, chain | Define o formato dos módulos do QR. |
| modules.color | string | "#111827" | - | Cor principal dos módulos. |
| modules.gradient | object|null | {"from":"#111827","to":"#10b981","direction":"diagonal"} | - | Gradiente opcional dos módulos. |
| modules.gradient.from | string | "#111827" | - | Cor inicial do gradiente. |
| modules.gradient.to | string | "#10b981" | - | Cor final do gradiente. |
| modules.gradient.direction | string | "diagonal" | top, bottom, left, right, diagonal | Direção do gradiente sobre os módulos do QR. |
| background.color | string | "#ffffff" | - | Cor de fundo da área. |
| background.transparent | boolean | false | - | Torna o fundo transparente. |
| Campo | Tipo | Exemplo | Valores permitidos | O que muda |
|---|---|---|---|---|
| finder.style | string | "double-border" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, sharp-circle-hole, square-hole, double-border | Forma do finder externo. |
| finder.centerStyle | string | "diamond" | square, rounded, circle, rounded-square, corner-top-left-sharp, corner-mix, star, heart, diamond | Forma do centro do finder. |
| finder.outerColor | string | "#111827" | - | Cor do anel externo do finder. |
| finder.innerColor | string | "#0ea5e9" | - | Cor do centro do finder. |
| finder.borderColor | string | "#111827" | - | Cor de destaque da borda do finder. |
| quietZone.size | number | 24 | - | Espaçamento da zona silenciosa ao redor do QR. |
| quietZone.modules | number | 4 | - | Controle de espaçamento baseado em módulos. |
| Campo | Tipo | Exemplo | Valores permitidos | O que muda |
|---|---|---|---|---|
| logo.enabled | boolean | true | - | Ativa a renderização do logo. |
| logo.assetId | string|null | "550e8400-e29b-41d4-a716-446655440000" | - | Referencia um asset de logo enviado pelo ID. |
| logo.sizePercent | number | 18 | - | Tamanho do logo em relação ao corpo do QR. |
| logo.padding | number | 6 | - | Espaço extra ao redor do logo. |
| logo.shape | string | "circle" | circle, square | Escolhe o formato da máscara do logo. |
| logo.backgroundColor | string | "#ffffff" | - | Fundo sob o logo. |
| logo.removeBackgroundBehindLogo | boolean | true | - | Remove módulos do QR atrás do logo. |
| logoDataUrl | string | "data:image/png;base64,..." | - | Data URL inline PNG/JPG/SVG para renderizar o logo diretamente. |