QR-код в одном запросе

Поиск и аутентификация

Проведите свой ключ в заголовке X-API-Ключ. сеансы редактора и файлы cookie не требуются. QIVO_API_KEY в этом примере является переменной среды клиента, содержащей ваш ключ.

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

Если ваша интеграция принимает только URL, перейдите ключ в ключевый параметр:

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

Заменить YOUR_SECRET_KEY вашим ключом. заголовка имеет преимущество над ключевым параметром. URL-кодирование параметров ценностей: # → %23, + → %2B, и & в пределах значения → %26.

Используйте HTTPS и держите ключ на вашем сервере.Не поместите его в общественный JavaScript. Ключи и данные в URL-адресах GET могут появляться в истории браузера или в журналах сервера; предпочтите заголовок для вашего ключа.

Код примеров

Сохранить ключ в QIVO_API_KEY среда променная; не публикуйте его в код страницы.

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

Дизайн параметров

Коды с логотипом автоматически используют уровень H. GET поддерживает встроенные иконы; файловые загрузки и URL-адреса внешнего логотипа не поддерживаются.

Типы контента

Полы зависят от контентаТип. Для URL-адресов, предоставить полный https:// или http:// адрес. Для телефонных номеров, включить код страны.

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

Огненные ответы

Успешным ответом является сам файл изображения, без JSON вкратчика. Content-Type является изображением/png или изображением/svg+xml.

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

• 200 — Изображение генерируется.
• 401 — Пропущенный или недействительный ключ.
• 405 — И это необходимо.
• 422 — Невалидные параметры или отсутствующий контент.
• 429 — Ограничение ставки превышалось; после возвращения: 60.
• 503 — API-доступ не конфигурируется или защита временно недоступна.
• 500 — Ошибка внутреннего поколения.

Ограничения и валидация

Ограничение по умолчанию составляет 60 запросов в минуту на IP. Зашифрованный контент ограничивается 800 байтами. Выход PNG поддерживает до 2048 × 2048 пк. SVG сохраняет векторные формы.

API подтверждает параметры форматов, размеры и контраст, но не выполняет декодер или проверяет, сканируют ли QR.