Guía de la API de Códigos QR para Desarrolladores

Clave API

La clave API para tu cuenta se puede crear en la página de cuenta. La clave API se puede incluir en las solicitudes como un parámetro de URL, por ejemplo: https://genqrcode.com/api/public/generate?apikey=TU_API_KEY, o dentro del encabezado `GenQRCode-apikey`. Para el resto de esta guía, asumiremos el uso del encabezado, ya que esta es la opción más segura, pero ambos métodos pueden ser utilizados de manera intercambiable. La clave API debe ser considerada como un secreto y no debes compartirla con nadie.

Limitación de tasa

Se aplica la limitación de tasa para garantizar un uso justo de la API. El nivel gratuito incluye 180 tokens por hora. Los códigos QR normales cuestan 1 token cada uno, con un límite máximo de 180 tokens por hora, lo que equivale a 1 código QR cada 20 segundos. Además, los puntos finales de llamadas rápidas costarán 1/50 de un token, lo que equivale a 2.5 códigos QR por segundo. Se recomienda usar estos puntos finales rápidos cuando no se requiera personalización del código QR. Si se excede el límite de tokens, se devolverá un código de estado 429, lo que indica que la solicitud ha sido limitada por la tasa.

El uso de múltiples cuentas para eludir estos límites está prohibido. Si se necesitan límites más altos, por favor contáctanos para obtener información sobre precios.

Bibliotecas

Java Library

API de Códigos QR Estáticos

Ejemplo de código QR de texto

URL	https://api.genqrcode.com/public/generate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "type": 0, "text": "https://genqrcode.com" }
Respuesta

Ejemplo de código QR de Wi-Fi

URL	https://api.genqrcode.com/public/generate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Respuesta

Ejemplo de código QR de color

URL	https://api.genqrcode.com/public/generate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Respuesta

Ejemplo de código QR con patrón de color

URL	https://api.genqrcode.com/public/generate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "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" }
Respuesta

Parámetros de marco, forma y logo

Aquí están todos los parámetros personalizables de marco, forma y logo descritos sobre cómo usarlos.

Parámetro	Tipo	Valor por defecto	Descripción
style	Int	0	Estilo de los cuadrados del código QR. 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 de los ojos internos del código QR. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Estilo de los ojos externos del código QR. 0 1 2 3 4 5 6
frame_style	Int	0	Estilo del marco alrededor del código QR. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	El texto dentro del marco. Un marco con texto debe ser configurado antes de que esto sea visible.
logo	String		El logo a usar dentro del código QR. 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	Si se debe eliminar el fondo detrás del logo.

Ejemplo de código QR con logo y forma

URL	https://api.genqrcode.com/public/generate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "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 }
Respuesta

API de Códigos QR Rápidos

La API de Códigos QR Rápidos solo cuesta 1/50 de los tokens de la API normal. Los códigos QR están optimizados para velocidad y tamaño de descarga. Aunque soporta todos los tipos de códigos QR, solo soporta algunos parámetros de personalización.

Ejemplo de código QR de texto rápido

URL	https://api.genqrcode.com/public/fastgenerate
Método de solicitud	POST
Encabezados	GenQRCode-apikey: API_KEY
Cuerpo	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Respuesta

API de Lotes Rápidos de Códigos QR

{
  "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
  }
}