Kod QR dalam satu permintaan

Permintaan dan pengesahan

Masukkan kunci anda ke dalam tajuk kunci X-API. sesi editor dan kuki tidak diperlukan. QIVO_API_KEY dalam contoh ini ialah variabel persekitaran klien yang mengandungi kunci anda.

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

Jika integrasi anda hanya menerima URL, masukkan kunci dalam parameter kunci:

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

Menggantikan YOUR_SECRET_KEY dengan kunci anda. tajuk mengambil keutamaan di atas parameter kunci. nilai parameter kod URL: # → %23, + → %2B, dan & dalam nilai → %26.

Gunakan HTTPS dan simpan kunci pada pelayan anda.Jangan letakkan ia dalam JavaScript awam.Kunci dan data dalam URL GET mungkin muncul dalam sejarah pelayar atau log pelayan; lebih suka tajuk untuk kunci anda.

Contoh Kod

Simpan kunci dalam variabel persekitaran QIVO_API_KEY; jangan menerbitkannya dalam kod halaman.

<?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())

Reka bentuk parameter

Kod dengan logo secara automatik menggunakan tahap H. GET menyokong ikon terbina dalam; muat naik fail dan URL logo luaran tidak disokong.

Jenis Kandungan

Untuk URL, berikan alamat https:// atau http:// lengkap. untuk nombor telefon, termasuk kod negara.

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

Penyelesaian api

Jawapan yang berjaya ialah fail imej itu sendiri, tanpa pengikat JSON. Jenis kandungan ialah imej/png atau imej/svg+xml. Kesilapan dikembalikan sebagai JSON:

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

• 200 — imej yang dihasilkan.
• 401 — kekurangan atau kekurangan kunci.
• 405 — GET yang diperlukan.
• 422 — parameter yang tidak sah atau kandungan yang hilang.
• 429 — Kadar yang melebihi; Retry-After: 60.
• 503 — Akses API tidak dikonfigurasi atau perlindungan sementara tidak tersedia.
• 500 — Kesilapan Generasi Dalam

Batas dan Validasi

Batas lalai ialah 60 permintaan per minit per IP. Kandungan yang disulitkan terhad kepada 800 byte. output PNG menyokong sehingga 2048 × 2048 px. SVG mengekalkan bentuk vektor.

API mengesahkan format parameter, saiz dan kontras, tetapi tidak menjalankan decoder atau memeriksa sama ada QR memindai.