Pāriet uz galveno saturu
GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.
Veidne glabā atkārtoti izmantojamu dizainu: styles, frameOptions un logoOptions. Tajā nekad nav satura vai saites. Veidnes ir kopīgas visiem darbvietas dalībniekiem.

Veidnes piemērošana

Nododiet templateId, kad izveidojat QR kodu. Veidnes dizains tiek piemērots jaunajam QR kodam. Jebkurš no trim dizaina objektiem, ko nosūtāt tajā pašā pieprasījumā, tiek apvienots virs tā.
  • Kopēts, nevis saistīts. QR kods saglabā savu dizaina kopiju. Veidnes vēlāka rediģēšana vai dzēšana to nemaina.
  • Tikai Custom dizaini. Veidni ar designKind branded vai ai nevar piemērot ar API, un tā atgriež 422 (art_template_unsupported).
  • Tikai jūsu darbvieta. Nezināma veidne vai veidne no citas darbvietas atgriež 404.

Galvenes

string
obligāts
Bearer, kam seko jūsu API atslēga. Skatiet Autentifikācija.
string
application/json. Obligāts pieprasījumos ar pamattekstu.

Veidnes objekts

string
Veidnes ID, piemēram, qrt_8Hs2mQvKpLd4RtYw.
string
Nosaukums, kas redzams, izvēloties veidni.
string
Tikai lasāms. custom ir dizains, ko API var pilnībā rediģēt. branded un ai ir informācijas panelī izveidots Branded vai AI dizains: tā attēlu nevar rediģēt ar API, un tas tiek saglabāts, kad maināt citus dizaina laukus.
object
Saglabātais dizains. Katram laukam ir tāda pati forma kā tāda paša nosaukuma pieprasījuma laukam, tāpēc varat to nosūtīt atpakaļ.
string
Izveides datums, ISO 8601.
string
Pēdējās atjaunināšanas datums, ISO 8601.

Veidņu saraksts

GET /api/v1/templates Atgriež jūsu darbvietas veidnes, sākot ar jaunākajām. Saraksts ir sadalīts lapās: skatiet Lapošana.
integer
noklusējums:"1"
Atgriežamā lapa, 1 vai vairāk.
integer
noklusējums:"100"
Rezultāti lapā, no 1 līdz 100.

Veidnes izveide

POST /api/v1/templates Saglabā jaunu dizainu. Atbild ar 201 Created. Dizaina lauki tiek pārbaudīti pret katalogiem sadaļā Pielāgošana, tāpēc nezināma forma, rāmis vai logotips tiek noraidīts ar 422.
string
obligāts
Nosaukums, kas redzams, izvēloties veidni, no 1 līdz 40 rakstzīmēm.
object
Punktu un stūru formas un krāsas. Skatiet Pielāgošana.
object
Rāmis ap QR kodu un tā aicinājuma rīkoties teksts. Skatiet Pielāgošana.
object
Logotips centrā: ieteiktais logotips vai jūsu fails, kas augšupielādēts ar Faili target logo. Skatiet Pielāgošana.

Veidnes iegūšana

GET /api/v1/templates/{templateId}
string
obligāts
Veidnes ID. Ņemiet to no saraksta vai izveides atbildes.

Veidnes atjaunināšana

PATCH /api/v1/templates/{templateId} Sūtiet tikai tos laukus, kurus vēlaties mainīt. Dizaina objekti tiek apvienoti ar saglabāto dizainu, tāpēc daļējs styles saglabā pārējo. No veidnes jau izveidotie QR kodi saglabā dizainu, ar kuru tie tika izveidoti.
string
obligāts
Veidnes ID.
string
Jauns nosaukums, no 1 līdz 40 rakstzīmēm.
object
Stila izmaiņas, kas tiek apvienotas ar saglabāto styles.
object
Rāmja izmaiņas, kas tiek apvienotas ar saglabāto rāmi.
object
Logotipa izmaiņas, kas tiek apvienotas ar saglabāto logotipu.

Veidnes dzēšana

DELETE /api/v1/templates/{templateId} Dzēš veidni. No tās izveidotie QR kodi saglabā savu dizainu.
string
obligāts
Veidnes ID.

Veidnes dublēšana

POST /api/v1/templates/{templateId}/duplicate Izveido kopiju ar nosaukumu <name> copy, ar savu ID un neatkarīgu dizainu, ko varat brīvi rediģēt. Nepieņem pieprasījuma pamattekstu. Atbild ar 201 Created.
string
obligāts
Kopējamās veidnes ID.

Biežākās problēmas

templateId neatbilst nevienai veidnei jūsu darbvietā. Ņemiet to no veidņu saraksta.
Kāds dizaina lauks neatbilst katalogiem, piemēram, nezināms punktu veids, rāmis vai ieteiktais logotips. Ziņojumā norādīts lauks. Skatiet Pielāgošana.
Veidne izmanto Branded vai AI dizainu. Tā vietā piemērojiet veidni ar designKind custom.

Kas tālāk

Pielāgošana

QR kodi

Veidnes lietotnē

Faili