Un código QR en una sola solicitud

Solicitud y autenticación

Pasar la llave en el encabezado X-API-Key. no se requieren sesiones de editor y cookies. QIVO_API_KEY en este ejemplo es una variable del entorno del cliente que contiene su llave.

curl --fail --show-error --get 'https://qivo.umind.group/' \
  --header "X-API-Key: $QIVO_API_KEY" \
  --data-urlencode 'data=https://umind.group' \
  --data-urlencode 'contentType=url' \
  --data-urlencode 'format=svg' \
  --data-urlencode 'shape=rounded' \
  --data-urlencode 'size=1024' \
  --output qr-code.svg

Si su integración acepta sólo una URL, pasa la llave en el parámetro clave:

https://qivo.umind.group/?key=YOUR_SECRET_KEY&data=https%3A%2F%2Fumind.group&format=png&size=1024

Substituye YOUR_SECRET_KEY con su clave. El título toma precedencia sobre el parámetro clave. URL-encodado parámetros valores: # → %23, + → %2B, y & dentro de un valor → %26.

Utilice HTTPS y mantenga la clave en su servidor. No la coloque en JavaScript público. Las claves y los datos en las URL de GET pueden aparecer en la historia del navegador o en los logs del servidor; prefiera el título para su clave.

Exemplos de código

Almacenar la llave en la variable del entorno QIVO_API_KEY; no la publique en código de página.

<?php
$key = getenv('QIVO_API_KEY');
if (!$key) throw new RuntimeException('Set QIVO_API_KEY');
$query = http_build_query([
    'data' => 'https://umind.group', 'format' => 'svg',
    'shape' => 'rounded', 'size' => 1024,
], '', '&', PHP_QUERY_RFC3986);
$curl = curl_init('https://qivo.umind.group/?' . $query);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . $key],
    CURLOPT_TIMEOUT => 30,
]);
$image = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
if ($image === false || $status !== 200) {
    throw new RuntimeException('Qivo request failed: ' . $status);
}
file_put_contents('qr-code.svg', $image);

import { writeFile } from 'node:fs/promises';
const key = process.env.QIVO_API_KEY;
if (!key) throw new Error('Set QIVO_API_KEY');
const url = new URL('https://qivo.umind.group/');
url.search = new URLSearchParams({
  data: 'https://umind.group', format: 'svg',
  shape: 'rounded', size: '1024'
});
const response = await fetch(url, {
  headers: { 'X-API-Key': key },
  signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error(`Qivo request failed: ${response.status}`);
await writeFile('qr-code.svg', Buffer.from(await response.arrayBuffer()));

import os
from pathlib import Path
from urllib.parse import urlencode
from urllib.request import Request, urlopen

key = os.environ['QIVO_API_KEY']
query = urlencode({
    'data': 'https://umind.group', 'format': 'svg',
    'shape': 'rounded', 'size': 1024,
})
request = Request('https://qivo.umind.group/?' + query,
                  headers={'X-API-Key': key})
# urlopen raises HTTPError for unsuccessful HTTP responses.
with urlopen(request, timeout=30) as response:
    Path('qr-code.svg').write_bytes(response.read())

Parámetros de diseño

Los códigos con un logotipo utilizan automáticamente el nivel H. GET soporta iconos integrados; las cargas de archivos y las URL de logotipo externos no se soportan.

Tipos de contenidos

Los campos dependen del contenidoType.Para las URLs, proporcione una dirección completa https:// o http://.Para los números de teléfono, incluye el código del país.

https://qivo.umind.group/?key=YOUR_SECRET_KEY&contentType=phone&phone=%2B380671234567&format=svg

Respuestas de fuego

Una respuesta exitosa es el propio archivo de imagen, sin un engranaje JSON.Type de contenido es imagen/png o imagen/svg+xml. Los errores se devuelven como JSON:

{"error":"Invalid API key."}

• 200 — La imagen generada.
• 401 — La clave ausente o invalida.
• 405 — GET es necesario.
• 422 — Parámetros invalidos o contenido ausente.
• 429 — El límite de tasa superado; Retiro-Después: 60.
• 503 — El acceso a API no está configurado o la protección no está temporalmente disponible.
• 500 — Errores de generación interna.

Límites y validación

El límite de default es 60 solicitudes por minuto por IP. El contenido codificado está limitado a 800 bytes. la salida PNG soporta hasta 2048 × 2048 px. SVG conserva las formas vectoras.

La API valida los formatos de parámetros, el tamaño y el contraste, pero no ejecuta un decodificador o verifica si los QR escanean.