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.
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, modelos e criações em massa. As formas, molduras ou logótipos desconhecidos são rejeitados com 422.
Exemplo de objeto de design
Estilos
O objetostyles define as formas e as cores do padrão.
- Cores. Apenas valores hexadecimais:
#RGBou#RRGGBB. - Correção de erros. Sempre
Q, e não é um parâmetro de entrada. Enviarstyles.qrOptionsdevolve422. - Branded designs e AI designs. Não podem ser definidos através da API. Enviar
styles.logoQrArtdevolve422. - Conteúdo.
styles.dataé ignorado. A imagem codifica sempre o conteúdo do código QR.
Molduras
O objetoframeOptions adiciona uma moldura decorativa com um apelo à ação à volta do código QR.
Molduras gerais
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, clipboardcard-hor não apresenta etiqueta.Molduras por tipo de código QR
Molduras por tipo de código QR
Qualquer moldura funciona com qualquer tipo de código QR. O agrupamento corresponde ao do painel.
textColor tem de ser diferente de color não se lhes aplica.
Logótipos
O objetologoOptions coloca um logótipo no centro do código QR. Defina type para escolher o tipo de logótipo.
Logótipo sugerido
Definatype como suggested e escolha um id do catálogo. Utilize logo-none para não ter logótipo.
Todos os IDs de logótipos sugeridos
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-blackO seu próprio logótipo
1
Carregue a imagem
Registe-a com Ficheiros 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.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,
styles,frameOptionselogoOptionssã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
templateIdna criação, os campos que enviar são combinados sobre o design do modelo. Consulte Modelos. - Branded designs e AI designs. Um código QR com
designKindbrandedouaifoi 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
422 "Error correction is always Q and is not an input"
422 "Error correction is always Q and is not an input"
Remova
styles.qrOptions do pedido.422 "Frame caption is at most 12 characters"
422 "Frame caption is at most 12 characters"
Encurte
frameOptions.text para 12 caracteres ou menos.422 "Frame caption color must differ from the frame color"
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.422 "Logo scale is a whole number from 15 to 45"
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.A cor dos cantos não muda
A cor dos cantos não muda
Os cantos usam sempre
dotsOptions.color. cornersSquareOptions.color e cornersDotOptions.color não têm efeito.