castomAPI
Odbierz klucz
POST /v1/generate/qrcode bezpłatny Bez klucza Generowanie

Generuj konfigurowalne kody QR w formacie Data URL (PNG)

Generuj konfigurowalne kody QR w formacie Data URL (PNG), SVG lub Terminal

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź

{
  "status": "success",
  "format": "svg",
  "size": 256,
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 29 29\" shape-rendering=\"crispEdges\">…</svg>",
  "tokensDeducted": 1
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Dowolny tekst lub adres w kod QR, jako ciąg SVG, PNG w data URL albo surowe bajty, z rozmiarem, marginesem i poziomem korekcji błędów do wyboru. SVG jest tym, który warto zachować: skaluje się do plakatu i waży kilobajt.

Kiedy użyć

Bilet, menu, karta Wi-Fi, link do płatności na fakturze, potwierdzenie rezerwacji.

Żądanie

Treść

PoleTypWymaganeOpis
darkColorstringnie
formatenumnieOne of: dataurl, svg, terminal.
lightColorstringnie
marginintegernie
textstringtak
widthintegernie

Przykładowe żądanie

{
  "data": "https://castomapi.com/",
  "format": "svg",
  "size": 256,
  "margin": 2,
  "errorCorrection": "M"
}

Odpowiedź

PoleTypOpis
formatstring
resultstring
statusstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "status": "success",
  "format": "svg",
  "size": 256,
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 29 29\" shape-rendering=\"crispEdges\">…</svg>",
  "tokensDeducted": 1
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/generate/qrcode' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"data": "https://castomapi.com/", "format": "svg", "size": 256, "margin": 2, "errorCorrection": "M"}'
const res = await fetch('https://app.castomapi.com/v1/generate/qrcode', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"data": "https://castomapi.com/", "format": "svg", "size": 256, "margin": 2, "errorCorrection": "M"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/generate/qrcode', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"data": "https://castomapi.com/", "format": "svg", "size": 256, "margin": 2, "errorCorrection": "M"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/generate/qrcode',
    headers={'x-api-key': '<your-api-key>'},
    json={"data": "https://castomapi.com/", "format": "svg", "size": 256, "margin": 2, "errorCorrection": "M"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/generate/qrcode');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['data' => 'https://castomapi.com/', 'format' => 'svg', 'size' => 256, 'margin' => 2, 'errorCorrection' => 'M']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Generuj konfigurowalne kody QR w formacie Data URL (PNG)?

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json