Guia da API de QR Code para Desenvolvedores

Chave da API

A chave da API para sua conta pode ser criada na página da conta. A chave da API pode ser incluída nas requisições como um parâmetro de URL, por exemplo: https://genqrcode.com/api/public/generate?apikey=SUA_CHAVE_API, ou dentro do cabeçalho GenQRCode-apikey. Para o restante deste guia, assumiremos o uso do cabeçalho, pois esta é a opção mais segura, mas ambos os métodos podem ser usados de forma intercambiável. A chave da API deve ser considerada secreta e você não deve compartilhá-la com ninguém.

Limitação de Taxa

A limitação de taxa é aplicada para garantir o uso justo da API. O plano gratuito inclui 180 tokens por hora. Os QR codes normais custam 1 token cada, com um limite máximo de 180 tokens por hora, o que equivale a 1 QR Code a cada 20 segundos. Além disso, os endpoints rápidos custam 1/50 de token, o que equivale a 2,5 QR Codes por segundo. Esses endpoints rápidos são recomendados quando nenhuma personalização do QR Code é necessária. Se o limite de tokens for excedido, um código de status 429 será retornado, indicando que a requisição foi limitada.

O uso de várias contas para contornar esses limites é proibido. Se forem necessários limites mais altos, entre em contato conosco para obter informações sobre preços.

Bibliotecas

Java Library

API de QR Code Estático

Exemplo de QR Code de texto

URL	https://api.genqrcode.com/public/generate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "type": 0, "text": "https://genqrcode.com" }
Resposta

Exemplo de QR Code de Wi-Fi

URL	https://api.genqrcode.com/public/generate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Resposta

Exemplo de QR Code colorido

URL	https://api.genqrcode.com/public/generate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Resposta

Exemplo de QR Code com padrão de cor

URL	https://api.genqrcode.com/public/generate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Resposta

Parâmetros de quadro, forma e logotipo

Aqui estão todos os parâmetros personalizáveis de quadro, forma e logotipo descritos sobre como usá-los.

Parâmetro	Tipo	Valor padrão	Descrição
style	Int	0	Estilo dos quadrados do QR Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Estilo dos olhos internos do QR Code. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Estilo dos olhos externos do QR Code. 0 1 2 3 4 5 6
frame_style	Int	0	Estilo da moldura ao redor do QR Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	O texto dentro da moldura. Uma moldura com texto precisa ser configurada antes que isso se torne visível.
logo	String		O logo a ser usado dentro do QR Code. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Se o fundo atrás do logo deve ser removido.

Exemplo de QR Code com logotipo e forma

URL	https://api.genqrcode.com/public/generate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Resposta

API de QR Code Rápido

A API de QR Code Rápido custa apenas 1/50 tokens da API normal. Os QR Codes são otimizados para velocidade e tamanho de download. Embora suporte todos os tipos de QR Code, ela só suporta alguns parâmetros de personalização.

Exemplo de QR Code rápido de texto

URL	https://api.genqrcode.com/public/fastgenerate
Método da requisição	POST
Cabeçalhos	GenQRCode-apikey: API_KEY
Corpo	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Resposta

API de QR Code de Lote Rápido

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}