Požadavek na QR kód
API URL = https://api.qrstart.eu
Method = POST

{
	'type': 'bank',
	'apikey': 'ApiKey',
	'amount': 1000,
	'currency': 'CZK',
	'date': '20210101',
	'account': '123456789/6666',
	'note': 'QR Platba',
	'variable': '20210001'
}

Odpověď na QR kód

{
  'success': true,
  'url': 'https://api.qrstart.eu/files/abcdefghijklmn.png'
}

Požadavek na upload PDF souboru
API URL = https://upload.qrstart.eu
Method = POST

{
	'apikey': 'ApiKey',
	'file': '/var/www/your-site/file.pdf'
}

Odpověď na upload PDF souboru

{
  'success': true,
  'fingerprint': '315add676b4eeb3f606cfe8903448ed8c2ac468d'
}

Vstupní parametry
  • type - typ kódu

    • možné hodnoty jsou bank, ean13, code128, text (výchozí bank)

    • type bank:

      • amount - částka (int nebo float)
        • povinné
      • currency - měna CZK nebo EUR
        • povinné pro CZ/SK bank
        • pro SEPA bank je currency automaticky EUR
      • bank - CZ nebo SK nebo SEPA
        • CZ pro český QR kód, SK pro slovenský QR kód (obecně tedy CZ pro české bankovní aplikace, SK pro slovenské bankovní aplikace)
        • SEPA znamená EPC SEPA formát
        • pokud není vyplněno, je použito CZ pro CZK měnu a SK pro EUR měnu
      • account - celé číslo účtu včetně kódu banky (123-456789123/4567)
        • povinné pro CZK, pokud nezadáte IBAN
      • iban - IBAN
        • povinné pro EUR (pro CZK pouze pokud nezadáte account)
      • swift - SWIFT kód (BIC)
      • variable - variabilní symbol
      • constant - konstantní symbol
      • specific - specifický symbol
      • note - poznámka pro zákazníka
      • date - datum splatnosti (YYYYMMDD)
      • size - velikost vygenerovaného obrázku v pixelech (min. 50, max. 600, výchozí 150)
        • pro generování do pdf souboru je velikost v mm
      • margin - okraje obrázku v pixelech (výchozí 2)
      • tag - interní poznámka (štítek viditelný v administraci, max. 50 znaků)
      • reference - reference plátce
        • pro SK bank EUR currency (variable a constant a specific musí být prázné)
        • pro SEPA bank
      • beneficiary - název/jméno příjemce
        • pouze pro SEPA bank
      • remittance - popis převodu
        • pouze pro SEPA bank (reference musí být prázná)
    • type ean13:

      • code - EAN-13 kód
        • povinné
      • size - 1-5 (int) (výchozí 2)
        • pro generování do pdf souboru je velikost v mm
      • tag - interní poznámka (štítek viditelný v administraci, max. 50 znaků)
    • type code128:

      • code - text
        • povinné
      • size - 1-5 (int) (výchozí 2)
        • pro generování do pdf souboru je velikost v mm
      • tag - interní poznámka (štítek viditelný v administraci, max. 50 znaků)
    • type text:

      • code - text
        • povinné
      • size - velikost vygenerovaného obrázku v pixelech (min. 50, max. 600, výchozí 150)
        • pro generování do pdf souboru je velikost v mm
      • margin - okraje obrázku v pixelech (výchozí 2)
      • tag - interní poznámka (štítek viditelný v administraci, max. 50 znaků)
  • pokud chcete do svého PDF souboru (max. velikost 1 MB) vložit QR kód, přidejte následující parametry

    • fingerprint - fingerprint z požadavku na upload
    • top - pozice shora v mm
    • bottom - pozice zdola v mm
      • v jednom požadavku použijte buď top nebo bottom
    • left - pozice zleva v mm
    • right - pozice zprava v mm
      • v jednom požadavku použijte buď left nebo right
    • page - stránka, na kterou se obrázek uloží (výchozí 1)
      • pro poslední stránku použijte hodnotu -1
  • standardně se obrázek QR kódu generuje jako PNG, můžete ho však generovat i jako JPG/WEBP

    • output - jpg nebo webp
      • hodnota jpg vytvoří obrázek v JPG formátu
      • hodnota webp vytvoří obrázek ve WEBP formátu
QR kód můžete také generovat GET požadavkem
Požadavek na QR kód
API URL = https://api.qrstart.eu
Method = GET

https://api.qrstart.eu/?type=bank&apikey=XXXXXX&amount=10&currency=EUR&iban=SK0123456789

Výsledkem, pokud je zadání validní, je URL obrázku qr kódu. V opačném případě text s chybou a http kód 400.
Pokud do URL dáte jako další parametr &image=1 tak se vám místo URL obrázku pošle rovnou samotný obrázek.
  • image - výstup jako obrázek s header Content-Type image/png (nebo image/jpeg nebo image/webp)
    • jediná možná hodnota je 1