> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Personalização

> Personalize códigos QR através da API: formas dos pontos e dos cantos, cores, molduras e logótipos.

> [!NOTE]
>
> A API do GetQR está em versão beta e só está disponível para alguns espaços de trabalho. Os detalhes podem mudar antes do lançamento geral.

Personalize um código QR com os objetos opcionais `styles`, `frameOptions` e `logoOptions` ao criá-lo ou atualizá-lo. Todos os campos são opcionais, e aplicam-se as predefinições a tudo o que omitir.

Os mesmos três objetos funcionam em [códigos QR](https://docs.getqr.com/pt/api/endpoints/qr-codes.md), [modelos](https://docs.getqr.com/pt/api/endpoints/templates.md) e [criações em massa](https://docs.getqr.com/pt/api/endpoints/bulk-qr-creations.md). As formas, molduras ou logótipos desconhecidos são rejeitados com `422`.

## Exemplo de objeto de design

```json theme={null}
{
  "styles": {
    "dotsOptions": { "type": "rounded", "color": "#000000" },
    "backgroundOptions": { "color": "#ffffff" },
    "cornersSquareOptions": { "type": "dot", "color": "#000000" },
    "cornersDotOptions": { "type": "dot", "color": "#000000" }
  },
  "frameOptions": { "id": "card", "text": "Scan me!", "color": "#000000", "textColor": "#ffffff" },
  "logoOptions": { "type": "suggested", "id": "logo-google", "scalePercent": 25 }
}
```

Envie-o com o resto do código QR:

```bash theme={null}
curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "styles": { "dotsOptions": { "type": "rounded", "color": "#1E40AF" } },
    "frameOptions": { "id": "card", "text": "Scan me!" },
    "logoOptions": { "type": "suggested", "id": "logo-website-3" }
  }'
```

## Estilos

O objeto `styles` define as formas e as cores do padrão.

| Campo | Valores |
| - | - |
| `dotsOptions.type` | Forma dos pontos do corpo: `square`, `dots`, `rounded`, `classy`, `classy-rounded`, `extra-rounded` |
| `cornersSquareOptions.type` | Forma do quadrado de canto (moldura do olho): `square`, `rounded`, `dot`, `classy-rounded` |
| `cornersDotOptions.type` | Forma do ponto de canto (pupila do olho): `square`, `dot`, `dots`, `rounded`, `classy` |
| `dotsOptions.color` | Cor do primeiro plano. Predefinição: `#000000`. |
| `backgroundOptions.color` | Cor de fundo. Predefinição: `#ffffff`. |
| `cornersSquareOptions.color`, `cornersDotOptions.color` | São aceites, mas não têm efeito: os cantos usam sempre `dotsOptions.color`. |

* **Cores.** Apenas valores hexadecimais: `#RGB` ou `#RRGGBB`.
* **Correção de erros.** Sempre `Q`, e não é um parâmetro de entrada. Enviar `styles.qrOptions` devolve `422`.
* **Branded designs e AI designs.** Não podem ser definidos através da API. Enviar `styles.logoQrArt` devolve `422`.
* **Conteúdo.** `styles.data` é ignorado. A imagem codifica sempre o conteúdo do código QR.

> [!TIP]
>
> Mantenha contraste suficiente entre as cores do primeiro plano e do fundo, com um primeiro plano escuro sobre um fundo claro. Os códigos com pouco contraste podem não ser lidos. Consulte [Cores](https://docs.getqr.com/pt/design/colors.md).

## Molduras

O objeto `frameOptions` adiciona uma moldura decorativa com um apelo à ação à volta do código QR.

| Campo | Descrição |
| - | - |
| `id` | Obrigatório quando envia `frameOptions`. O tipo de moldura, das listas abaixo. `none` significa sem moldura. |
| `text` | Etiqueta do apelo à ação, até 12 caracteres. Predefinição: `Scan me!`. |
| `color` | Cor da moldura, em hexadecimal. |
| `textColor` | Cor da etiqueta, em hexadecimal. Tem de ser diferente de `color` quando a moldura apresenta uma etiqueta, exceto se o par for uma das predefinições de cor da moldura. |
| `borderColor` | Cor do contorno, em hexadecimal. |
| `fingerPrintColor` | Cor de destaque do ícone da moldura, em hexadecimal. |

> [accordion] Molduras gerais
>
> `none`, `card`, `card-1`, `card-2`, `card-3`, `card-4`, `card-5`, `card-7`, `card-8`, `card-9`, `card-10`, `card-11`, `card-12`, `card-13`, `card-14`, `card-15`, `card-hor`, `wreath`, `envelope`, `waitress`, `coffee-cup`, `scooter`, `clipboard`
>
> `card-hor` não apresenta etiqueta.

> [accordion] Molduras por tipo de código QR
>
> | Tipo | Molduras com etiqueta | Molduras sem etiqueta |
> | - | - | - |
> | App Link | `app-3` | `app-1`, `app-2` |
> | vCard | `contact-1`, `contact-5` | `contact-2`, `contact-3`, `contact-4` |
> | Email | `email-1` | `email-2`, `email-3`, `email-4`, `email-5` |
> | Feedback | — | `feedback-1`, `feedback-2`, `feedback-3`, `feedback-4`, `feedback-5` |
> | Image | — | `image-1`, `image-2`, `image-3`, `image-4`, `image-5`, `image-6` |
> | Localização | `location-3` | `location-1`, `location-2`, `location-4`, `location-5`, `location-6` |
> | Multi-Link | `multilink-3` | `multilink-1`, `multilink-2` |
> | Pagamento | — | `payment-1`, `payment-2`, `payment-3`, `payment-4`, `payment-5` |
> | PDF | `pdf-1` | `pdf-2`, `pdf-3`, `pdf-4` |
> | SMS | `sms-3`, `sms-5`, `sms-7` | `sms-1`, `sms-2`, `sms-4`, `sms-6` |
> | Social Media | `social-3` | `social-1`, `social-2`, `social-4` |
> | Video | `video-1`, `video-3` | `video-2`, `video-4`, `video-5`, `video-6` |
> | Website | `website-1` | `website-2`, `website-3`, `website-4`, `website-5` |
> | WhatsApp | `whatsapp-2` | `whatsapp-1`, `whatsapp-3`, `whatsapp-4` |
> | WiFi | — | `wifi-1`, `wifi-2`, `wifi-3`, `wifi-4` |
>
> Qualquer moldura funciona com qualquer tipo de código QR. O agrupamento corresponde ao do painel.

As molduras sem etiqueta não têm campo de apelo à ação no painel, e a regra de que `textColor` tem de ser diferente de `color` não se lhes aplica.

## Logótipos

O objeto `logoOptions` coloca um logótipo no centro do código QR. Defina `type` para escolher o tipo de logótipo.

### Logótipo sugerido

Defina `type` como `suggested` e escolha um `id` do catálogo. Utilize `logo-none` para não ter logótipo.

```json theme={null}
{ "logoOptions": { "type": "suggested", "id": "logo-instagram", "scalePercent": 25 } }
```

> [accordion] Todos os IDs de logótipos sugeridos
>
> `logo-none`, `logo-website-3`, `logo-website-4`, `logo-link`, `logo-pdf-1`, `logo-pdf-2`, `logo-pdf-3`, `logo-picture-1`, `logo-picture-2`, `logo-picture-3`, `logo-picture-5`, `logo-picture-7`, `logo-picture-8`, `logo-video-1`, `logo-video-5`, `logo-whatsapp-1`, `logo-whatsapp-2`, `logo-whatsapp`, `logo-wifi-1`, `logo-wifi-2`, `logo-wifi-3`, `logo-wifi`, `logo-airbnb`, `logo-apple`, `logo-binance`, `logo-bitcoin`, `logo-bolt-food`, `logo-booking`, `logo-facebook`, `logo-glovo`, `logo-google`, `logo-google-maps`, `logo-google-play`, `logo-instagram`, `logo-linkedin`, `logo-location`, `logo-mail`, `logo-paypal`, `logo-stripe`, `logo-venmo`, `logo-cashapp`, `logo-braintree`, `logo-square`, `logo-verifone`, `logo-google-pay`, `logo-apple-pay`, `logo-klarna`, `logo-ayden`, `logo-giropay`, `logo-cartes-bancaires`, `logo-restaurant`, `logo-scan-me`, `logo-tripadvisor`, `logo-trustpilot`, `logo-uber-eats`, `logo-youtube`, `logo-spotify`, `logo-spotify-black`

### O seu próprio logótipo

**1. Carregue a imagem**

Registe-a com [Ficheiros](https://docs.getqr.com/pt/api/endpoints/files.md) usando `"target": "logo"` e, em seguida, carregue o ficheiro para o `uploadUrl` devolvido.

**2. Referencie o ficheiro**

Defina `type` como `uploaded` e `fileId` com o `fileId` devolvido. `fileId` é obrigatório e tem de ser um ID devolvido pelo endpoint de ficheiros.

```json theme={null}
{ "logoOptions": { "type": "uploaded", "fileId": "file_7bQ2xR9mKp", "scalePercent": 35 } }
```

Um ficheiro desconhecido, um carregamento não concluído ou um ficheiro carregado para outro target é rejeitado.

### Tamanho do logótipo

`scalePercent` define o tamanho do logótipo como uma percentagem do código QR. Aceita um número inteiro de 15 a 45. A predefinição é 25. Outros valores, incluindo proporções como `0.25`, devolvem `422`.

## Atualizar um design

* **Atualizações parciais.** Em [Atualizar um código QR](https://docs.getqr.com/pt/api/endpoints/qr-codes.md#atualizar-um-código-qr), `styles`, `frameOptions` e `logoOptions` são combinados com o design guardado. Um objeto parcial só altera o que indica.
* **Mudar o logótipo.** Escolher outro logótipo substitui o guardado, mas mantém o respetivo `scalePercent`.
* **Modelos.** Com `templateId` na criação, os campos que enviar são combinados sobre o design do modelo. Consulte [Modelos](https://docs.getqr.com/pt/api/endpoints/templates.md).
* **Branded designs e AI designs.** Um código QR com `designKind` `branded` ou `ai` foi criado no painel. A API não pode editar a respetiva imagem, mas mantém-na quando altera outros campos.
* **Ler um design.** As respostas devolvem o design guardado em `design`, com a mesma estrutura dos campos do pedido, pelo que o pode reenviar.

## Problemas comuns

> [accordion] 422 "Error correction is always Q and is not an input"
>
> Remova `styles.qrOptions` do pedido.

> [accordion] 422 "Frame caption is at most 12 characters"
>
> Encurte `frameOptions.text` para 12 caracteres ou menos.

> [accordion] 422 "Frame caption color must differ from the frame color"
>
> `textColor` e `color` são iguais numa moldura que apresenta uma etiqueta. Escolha um `textColor` que contraste.

> [accordion] 422 "Logo scale is a whole number from 15 to 45"
>
> Envie `scalePercent` como uma percentagem inteira, por exemplo `25`, e não `0.25`.

> [accordion] A cor dos cantos não muda
>
> Os cantos usam sempre `dotsOptions.color`. `cornersSquareOptions.color` e `cornersDotOptions.color` não têm efeito.

## Próximos passos

> [card] [Códigos QR](https://docs.getqr.com/pt/api/endpoints/qr-codes.md)

> [card] [Modelos](https://docs.getqr.com/pt/api/endpoints/templates.md)

> [card] [Ficheiros](https://docs.getqr.com/pt/api/endpoints/files.md)

> [card] [Visão geral do design](https://docs.getqr.com/pt/design/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.