QivoQR kód štúdia
Vytvorenie QR kódu

Pre integráciu

QR kód v jednej žiadosti

Pridajte generáciu kódu QR do služby. Pošlite obsah a nastavenia dizajnu prostredníctvom GET / POST a dostanete PNG alebo SVG bez ďalšieho skenovania.

Voľný - navždyPNG, SVG a API – žiadne poplatky alebo predplatné.

Priame QR kódy. Žiadne prevedenie, žiadne vypršanie.

GET / POSThttps://qivo.umind.group/

Žiadosť a autentifikácia

Prejdite kľúč do hlavy X-API-Kľúč. Editorové relácie a súbory cookie nie sú potrebné. QIVO_API_KEY v tomto príklade je variabilný prostredie klienta, ktorý obsahuje kľúč.

Príklad kurkumu
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

Ak vaša integrácia akceptuje iba URL, prejdite kľúč do kľúčového parametra:

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

Náhradou kľúča nájde názov prednosť nad kľúčovým parametrom. hodnoty parametrov kódovania URL: # → %23, + → %2B a & v rámci hodnoty → %26.

Použite HTTPS a uchovávajte kľúč na serveri.Nevložte ho do verejného JavaScript.Kľúčy a údaje v URL adresách GET sa môžu zobrazovať v histórii prehliadača alebo v záznamoch servera; vyberajte hlavičku pre kľúč.

Príklady kódu

Uložiť kľúč v QIVO_API_KEY prostredie variable; nepublikujte ho v kóde stránky.

qr-code.php
<?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);
qr-code.mjs
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()));
qr-code.py
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())

Logo nahrávanie

POSThttps://qivo.umind.group/

Content-Type: multipart/form-data
X-API-Key: YOUR_SECRET_KEY

Qivo prijíma súbory PNG, JPEG a WebP až do 2 MB, s maximálnou stranou 2048 pixelov. SVG nahrávky nie sú akceptované. PNG alebo WebP s transparentnosťou funguje dobre pre značku bez pozadia.

ParametreTypPožiadavkyhodnoty
X-API-KeyheaderPotrebnéYOUR_SECRET_KEY
logostringPotrebnéupload
logoFilefilePotrebnéPNG / JPEG / WebP · ≤ 2 MiB · ≤ 2048 × 2048 px · ≤ 4,000,000 px
logoScaleintegerOpcionálne12–30 · Defaultné: 24
logoPaddingintegerOpcionálne0–25% · Defaultné: 5

GET → logo=none / whatsapp / …
POST → logo=upload + logoFile
logoUrl / logoBase64 / SVG / GIF → 422
Content-Length > 3 MiB → 413
level → H

cURL · multipart/form-data
curl --fail --show-error 'https://qivo.umind.group/' \
  --header "X-API-Key: $QIVO_API_KEY" \
  --form-string 'data=https://umind.group' \
  --form-string 'format=svg' \
  --form-string 'logo=upload' \
  --form-string 'logoPadding=10' \
  --form-string 'logoScale=24' \
  --form 'logoFile=@./logo.png;type=image/png' \
  --output qr-code.svg
PHP · CURLFile
<?php
$key = getenv('QIVO_API_KEY');
if (!$key) throw new RuntimeException('Set QIVO_API_KEY');
$curl = curl_init('https://qivo.umind.group/');
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . $key],
    CURLOPT_TIMEOUT => 30,
    CURLOPT_POSTFIELDS => [
        'data' => 'https://umind.group', 'format' => 'png',
        'logo' => 'upload', 'logoScale' => '24', 'logoPadding' => '10',
        'logoFile' => new CURLFile(__DIR__ . '/logo.png', 'image/png', 'logo.png'),
    ],
]);
$image = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
if ($image === false || $status !== 200) throw new RuntimeException('Qivo: ' . $status);
file_put_contents('qr-code.png', $image);
JavaScript · Node.js 20+
import { readFile, writeFile } from 'node:fs/promises';
const key = process.env.QIVO_API_KEY;
if (!key) throw new Error('Set QIVO_API_KEY');
const form = new FormData();
form.set('data', 'https://umind.group');
form.set('format', 'svg');
form.set('logo', 'upload');
form.set('logoPadding', '10');
form.set('logoFile', new Blob([await readFile('./logo.png')], { type: 'image/png' }), 'logo.png');
// FormData supplies Content-Type and the multipart boundary automatically.
const response = await fetch('https://qivo.umind.group/', {
  method: 'POST', headers: { 'X-API-Key': key }, body: form,
  signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error(`Qivo: ${response.status}`);
await writeFile('qr-code.svg', Buffer.from(await response.arrayBuffer()));
Python · requests
# python -m pip install requests
import os
from pathlib import Path
import requests

with open('logo.png', 'rb') as logo:
    response = requests.post(
        'https://qivo.umind.group/',
        headers={'X-API-Key': os.environ['QIVO_API_KEY']},
        data={'data': 'https://umind.group', 'format': 'svg', 'logo': 'upload', 'logoPadding': '10'},
        files={'logoFile': ('logo.png', logo, 'image/png')},
        timeout=30,
    )
response.raise_for_status()
Path('qr-code.svg').write_bytes(response.content)

QR geometria vo vnútri SVG je vektorovo založená. Vaše nahrané logo je vložené ako čistený rasterový obrázok, takže jeho detail sa nestane neobmedzeným. Pre veľký plagát, skontrolujte jasnosť loga samostatne.

Designové parametre

ParametreTypPožiadavkyhodnoty
X-API-Key / keystringPotrebné
Tajný kľúč: hlavička alebo parameter GET
datastringPre text a url
Potrebný obsah pre text / URL
contentTypestringOpcionálne
texturlwifivcardwhatsapptelegramphoneviberemailsms
Defaultné: text
formatstringOpcionálne
pngsvg
Defaultné: png
sizeintegerOpcionálne
25651210242048
Defaultné: 1024
shapestringOpcionálne
squaresoftroundeddotsleaf-softleafhorizontalverticalpointednotchedstardiamondxx-roundedplusplus-roundedheartsparkleconfetti
Defaultné: square
borderstringOpcionálne
squarecircleroundedskewdrop-tldrop-brleafleaf-inner-brleaf-circleleaf-inner-tlsquare-circlesoft-tlsoft-brsoft-leafrough
Defaultné: square
centerstringOpcionálne
squarecircleroundedskewroughdrop-tldrop-brleafgearstardiamondxx-roundedplusplus-roundedheart
Defaultné: square
foreground / eyeColorstringOpcionálne
#RRGGBB
Defaultné: #192b39
backgroundstringOpcionálne
#RRGGBB
Defaultné: #ffffff
levelstringOpcionálne
LMQH
Defaultné: M
quietZoneintegerOpcionálne
0 - 12 modulov
Defaultné: 4
logostringOpcionálne
noneuploadwhatsapplinklocationwificredentialemailscanbellmenuscan-mescan-me-v2paypalbitcoinsparkplusdiamond
Defaultné: none
logoScaleintegerOpcionálne
12–30
Defaultné: 24
logoPaddingintegerOpcionálne
0–25%
Defaultné: 5

logo=upload → POST / · logoFile · level=H

typy obsahu

Polia závisia od obsahuType. pre URL, poskytnúť kompletnú https:// alebo http:// adresu. pre telefónne čísla, zahŕňajú kód krajiny.

contentTypePotrebné poliaVoliteľné polia
text / urldata—
phone / viberphone—
whatsapp / smsphonemessage
telegramtelegram—
emailemailsubject, message
wifissid; wifiSecurity≠nopass → wifiPasswordwifiSecurity (WPA), wifiHidden (0)
vcardfirstName / lastNameorganization, jobTitle, phone, email, website, address
Telefónny príklad
https://qivo.umind.group/?key=YOUR_SECRET_KEY&contentType=phone&phone=%2B380671234567&format=svg

Odpoveď na požiar

Úspešnou odpoveďou je obrazový súbor sám, bez JSON vŕtačky. obsahový typ je obrázok/png alebo obrázok/svg+xml. Chyby sa vrátia ako JSON:

JSON
{"error":"Invalid API key."}
  • 200 — Obrázok je vytvorený.
  • 401 — Chýbajúce alebo neplatné kľúče.
  • 405 — GET / POST
  • 413 — Content-Length > 3 MiB
  • 415 — POST: multipart/form-data
  • 422 — Invalidné parametre alebo chýbajúci obsah.
  • 429 — Rýchlosť prekročila; Retry-After: 60.
  • 503 — Prístup k API nie je konfigurovaný alebo ochrana je dočasne nedostupná.
  • 500 — Poruchy vnútornej generácie.

Limity a validácia

Predvolená hranica je 60 požiadaviek za minútu na IP. Šifrovaný obsah je obmedzený na 800 bajtov. PNG výstup podporuje až 2048 × 2048 px. SVG zachováva vektorové tvary.

API validuje formáty parametrov, veľkosť a kontrast, ale nefunguje decoder alebo skontroluje, či QR skenuje.

Získajte prístup

API je zadarmo a vždy zostane zadarmo. vyplňte krátky formulár a požiadajte o tajný kľúč.

Podrobnosti o formulári budú odoslané tímu Qivo na preskúmanie vašej žiadosti a odpovede.