Un codi QR en una sol·licitud

Sol·licitud i autenticació

Passar la clau en l'anomenada X-API-Key. no es requereixen sessions d'editorial i cookies. QIVO_API_KEY en aquest exemple és una variable de medi ambient del client que conté la seva clau.

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 la seva integració accepta només una URL, passa la clau en el paràmetre clau:

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

El títol pren precisió sobre el paràmetre clau. URL-encodeix els valors del paràmetre: # → %23, + → %2B, i & dins d'un valor → %26.

Utilitzeu HTTPS i mantingueu la clau al vostre servidor. No la poseu en JavaScript públic. Les claus i les dades en les URL de GET poden aparèixer en la història del navegador o en els logs del servidor; prefereix el títol per a la clau.

Exemples de codi

Emmagatzema la clau en la variable mediambiental QIVO_API_KEY; no la publiqueu en codi 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àmetres de disseny

Els codis amb un logotip utilitzen automàticament el nivell H. GET recolza icones integrades; no es recolzen les carregades de fitxers i URLs externs del logotip.

Tipus de continguts

Els camps depenen del contingutTip. per a les URL, proporcionar una adreça completa https:// o http://. per als números de telèfon, inclou el codi de país.

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

Reacció de l'Api

Una resposta reeixida és el fitxer d'imatge en si, sense un xifrat JSON. El tipus de contingut és imatge/png o imatge/svg+xml. Els errors es retornen com a JSON:

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

• 200 — Imatge generada.
• 401 — La clau desapareguda o invalidada.
• 405 — GET es requereix.
• 422 — Paràmetres invalidats o continguts faltants.
• 429 — El límit de la taxa ha superat; Retre-After: 60.
• 503 — L'accés a API no està configurat o la protecció és temporalment inaccessible.
• 500 — Errors de generació interna.

Límits i validació

El límit de default és 60 sol·licituds per minut per IP. El contingut encodat està limitat a 800 bytes. La sortida PNG suporta fins a 2048 × 2048 px. SVG conserva les formes vectores.

L'API valida els formats de paràmetres, la mida i el contrast, però no executa un decoder o comprova si els QR escaneixen.