De GetQR API is in bèta en beschikbaar voor geselecteerde workspaces. Details kunnen nog veranderen vóór de algemene release.
styles, frameOptions en logoOptions. Het bevat nooit inhoud of een link. Sjablonen worden gedeeld met iedereen in de workspace.
Een sjabloon toepassen
GeeftemplateId mee wanneer je een QR-code maakt. Het ontwerp van het sjabloon wordt op de nieuwe QR-code toegepast. Ontwerpobjecten die je in hetzelfde verzoek meestuurt, worden eroverheen samengevoegd.
- Gekopieerd, niet gekoppeld. De QR-code houdt een eigen kopie van het ontwerp. Als je het sjabloon later bewerkt of verwijdert, verandert de QR-code niet.
- Alleen eigen ontwerpen. Een sjabloon met
designKindbrandedofaikan niet via de API worden toegepast en geeft422(art_template_unsupported). - Alleen je eigen workspace. Een onbekend sjabloon, of een sjabloon uit een andere workspace, geeft
404.
Headers
string
vereist
Bearer gevolgd door je API-sleutel. Zie Authenticatie.string
application/json. Verplicht bij verzoeken met een body.Het sjabloonobject
string
ID van het sjabloon, bijvoorbeeld
qrt_8Hs2mQvKpLd4RtYw.string
Naam die je ziet bij het kiezen van een sjabloon.
string
Alleen-lezen.
custom is een ontwerp dat de API volledig kan bewerken. branded en ai zijn een Branded design of AI design dat in het dashboard is gemaakt: de afbeelding ervan kun je niet via de API bewerken, en die blijft behouden wanneer je de andere ontwerpvelden wijzigt.object
Het opgeslagen ontwerp. Elk veld heeft dezelfde vorm als het gelijknamige veld in het verzoek, zodat je het terug kunt sturen.
string
Aanmaakdatum, ISO 8601.
string
Datum van de laatste update, ISO 8601.
Sjablonen weergeven
GET /api/v1/templates
Geeft de sjablonen van je workspace terug, de nieuwste eerst. De lijst is gepagineerd: zie Paginering.
integer
standaard:"1"
Pagina die wordt teruggegeven, 1 of hoger.
integer
standaard:"100"
Resultaten per pagina, 1 tot 100.
Een sjabloon maken
POST /api/v1/templates
Slaat een nieuw ontwerp op. Antwoordt met 201 Created. De ontwerpvelden worden gecontroleerd tegen de catalogi in Aanpassing, dus een onbekende vorm, een onbekend frame of een onbekend logo wordt geweigerd met 422.
string
vereist
Naam die je ziet bij het kiezen van een sjabloon, 1 tot 40 tekens.
object
Vormen en kleuren van stippen en hoeken. Zie Aanpassing.
object
Frame rond de QR-code en de bijbehorende call-to-actiontekst. Zie Aanpassing.
object
Logo in het midden: een voorgesteld logo, of je eigen bestand, geüpload met de target
logo van Bestanden. Zie Aanpassing.Een sjabloon ophalen
GET /api/v1/templates/{templateId}
string
vereist
ID van het sjabloon. Neem die over uit het antwoord van de lijst of van het aanmaken.
Een sjabloon bijwerken
PATCH /api/v1/templates/{templateId}
Stuur alleen de velden die je wilt wijzigen. Ontwerpobjecten worden samengevoegd met het opgeslagen ontwerp, dus bij een gedeeltelijke styles blijft de rest behouden. QR-codes die al met het sjabloon zijn gemaakt, houden het ontwerp waarmee ze zijn gemaakt.
string
vereist
ID van het sjabloon.
string
Nieuwe naam, 1 tot 40 tekens.
object
Stijlwijzigingen, samengevoegd met de opgeslagen
styles.object
Framewijzigingen, samengevoegd met het opgeslagen frame.
object
Logowijzigingen, samengevoegd met het opgeslagen logo.
Een sjabloon verwijderen
DELETE /api/v1/templates/{templateId}
Verwijdert het sjabloon. QR-codes die ermee zijn gemaakt, houden hun ontwerp.
string
vereist
ID van het sjabloon.
Een sjabloon dupliceren
POST /api/v1/templates/{templateId}/duplicate
Maakt een kopie met de naam <name> copy, met een eigen ID en een onafhankelijk ontwerp dat je vrij kunt bewerken. Heeft geen request-body. Antwoordt met 201 Created.
string
vereist
ID van het sjabloon dat je wilt kopiëren.
Veelvoorkomende problemen
404 "QR template not found."
404 "QR template not found."
De
templateId komt niet overeen met een sjabloon in je workspace. Neem hem over uit Sjablonen weergeven.422 bij het maken of bijwerken van een sjabloon
422 bij het maken of bijwerken van een sjabloon
Een ontwerpveld komt niet overeen met de catalogi, bijvoorbeeld een onbekend stiptype, frame of voorgesteld logo. Het bericht noemt het veld. Zie Aanpassing.
422 art_template_unsupported bij het maken van een QR-code
422 art_template_unsupported bij het maken van een QR-code
Het sjabloon gebruikt een Branded design of AI design. Pas in plaats daarvan een sjabloon toe met
designKind custom.