Guia Prática Qivo
Como funciona uma API de geração de código QR
Uma API permite que você gerar códigos QR automaticamente do seu site, ferramenta interna ou script.
Sua aplicação envia conteúdo e configurações; Qivo retorna uma imagem QR estática.
De um editor manual para uma integração
No editor, uma pessoa enche campos e clique em download. com uma API, um programa realiza essas ações, por exemplo, gerando um código QR da página de produto enquanto prepara uma etiqueta.
Uma chamada de API não torna o código dinâmico. a imagem armazena os dados enviados em vez de uma URL Qivo intermediária. você pode salvar e usar o arquivo sem entrar em contato com o gerador novamente.
O que uma solicitação contém
Um pedido GET contém o endereço de serviço, parâmetros e uma chave secreta. o conteúdoType parâmetro seleciona o tipo de dados, formato seleciona PNG ou SVG, e forma, fronteira e centro controla o design. texto plano requer o campo de dados.
Os valores de parâmetros devem ser codificados por URL. Use as ferramentas padrão da sua língua para lidar corretamente com espaços, os + em números de telefone e os # em cores.
Por que a chave pertence ao seu servidor
A chave permite o acesso à geração.Os visitantes podem ler uma chave colocada em uma página pública no JavaScript.Enviar pedidos do seu servidor e carregar a chave de uma variável ambiental.
Envie a chave no cabeçalho X-API-Key através do HTTPS. O parâmetro URL chave também é suportado, mas URLs podem aparecer em histórico e logs. Nunca coloque a chave secreta na imagem QR ou exemplos públicos.
Como lidar com a resposta
Uma resposta bem sucedida contém a imagem em si, não JSON com um link de download. Verifique o status HTTP antes de salvar. Erros retornam JSON com uma explicação; não salve isso como um PNG.
SVG é útil para materiais impressos, enquanto PNG se encaixa em imagens diárias. Evite regenerar um código em cada visita a uma página inalterada: salvar e reutilizar o arquivo. Respeite os limites de solicitação e o retraso.
O que verificar antes de publicar
A API valida a entrada, mas não decode a imagem acabada. Isso reduz o processamento, mas seu fluxo de trabalho deve lidar com os testes de escaneamento. Teste combinações típicas de design e os maiores volumes de dados que você espera.
Deixe uma zona tranquila de pelo menos quatro módulos, bom contraste e tamanho suficiente. Escanear o layout impresso final com um telefone. A página API contém parâmetros técnicos e exemplos prontos para uso PHP, JavaScript, Python e cURL.
Fontes e Leia mais
Preparado e mantido por Umind. Teste essas recomendações em seu layout final e dispositivos alvo.