GetQR API je v beta verzi a je dostupné pro vybrané pracovní prostory. Do obecného vydání se podrobnosti mohou změnit.
styles, frameOptions a logoOptions. Nikdy neobsahuje obsah ani odkaz. Šablony sdílí všichni v pracovním prostoru.
Použití šablony
PředejtetemplateId, když vytváříte QR kód. Design šablony se použije pro nový QR kód. Kterýkoli ze tří objektů designu, který pošlete ve stejném požadavku, se s ním sloučí a má přednost.
- Kopie, ne propojení. QR kód si ponechá vlastní kopii designu. Pozdější úprava nebo smazání šablony ho nezmění.
- Jen vlastní designy. Šablonu s
designKindbrandedneboainelze přes API použít a vrátí422(art_template_unsupported). - Jen váš pracovní prostor. Neznámá šablona nebo šablona z jiného pracovního prostoru vrátí
404.
Hlavičky
string
application/json. Povinné u požadavků s tělem.Objekt šablony
string
ID šablony, například
qrt_8Hs2mQvKpLd4RtYw.string
Název zobrazený při výběru šablony.
string
Jen pro čtení.
custom je design, který API může plně upravovat. branded a ai jsou design Branded nebo AI vytvořený v dashboardu: jeho obrázek přes API upravit nelze a při změně ostatních polí designu se zachová.object
Uložený design. Každé pole má stejný tvar jako stejnojmenné pole požadavku, takže ho můžete poslat zpět.
string
Datum vytvoření, ISO 8601.
string
Datum poslední úpravy, ISO 8601.
Výpis šablon
GET /api/v1/templates
Vrací šablony vašeho pracovního prostoru od nejnovějších. Seznam je stránkovaný: viz Stránkování.
integer
výchozí:"1"
Stránka, která se má vrátit, 1 nebo vyšší.
integer
výchozí:"100"
Počet výsledků na stránku, 1 až 100.
Vytvoření šablony
POST /api/v1/templates
Uloží nový design. Odpoví 201 Created. Pole designu se ověřují podle katalogů v části Přizpůsobení, takže neznámý tvar, rámeček nebo logo se odmítne s 422.
string
povinné
Název zobrazený při výběru šablony, 1 až 40 znaků.
object
Tvary a barvy bodů a rohů. Viz Přizpůsobení.
object
Rámeček kolem QR kódu a text jeho výzvy k akci. Viz Přizpůsobení.
object
Logo uprostřed: navrhované logo nebo vlastní soubor nahraný s cílem
logo přes Soubory. Viz Přizpůsobení.Získání šablony
GET /api/v1/templates/{templateId}
string
povinné
ID šablony. Najdete ho v odpovědi výpisu nebo vytvoření.
Úprava šablony
PATCH /api/v1/templates/{templateId}
Pošlete jen pole, která chcete změnit. Objekty designu se sloučí s uloženým designem, takže částečné styles zachová zbytek. QR kódy už vytvořené ze šablony si ponechají design, se kterým vznikly.
string
povinné
ID šablony.
string
Nový název, 1 až 40 znaků.
object
Změny stylů, sloučené s uloženými
styles.object
Změny rámečku, sloučené s uloženým rámečkem.
object
Změny loga, sloučené s uloženým logem.
Smazání šablony
DELETE /api/v1/templates/{templateId}
Smaže šablonu. QR kódy, které z ní vznikly, si design ponechají.
string
povinné
ID šablony.
Duplikace šablony
POST /api/v1/templates/{templateId}/duplicate
Vytvoří kopii s názvem <name> copy, s vlastním ID a nezávislým designem, který můžete volně upravovat. Nepřijímá tělo požadavku. Odpoví 201 Created.
string
povinné
ID šablony, která se má zkopírovat.
Časté problémy
404 "QR template not found."
404 "QR template not found."
templateId neodpovídá žádné šabloně ve vašem pracovním prostoru. Převezměte ho z výpisu šablon.422 při vytváření nebo úpravě šablony
422 při vytváření nebo úpravě šablony
Některé pole designu neodpovídá katalogům, například neznámý typ bodů, rámeček nebo navrhované logo. Zpráva uvádí název pole. Viz Přizpůsobení.
422 art_template_unsupported při vytváření QR kódu
422 art_template_unsupported při vytváření QR kódu
Šablona používá design Branded nebo AI. Použijte místo ní šablonu s
designKind custom.