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.
Lielapjoma izveide pārvērš nosaukumu un URL sarakstu par Website QR kodiem ar vienu kopīgu dizainu. Tā darbojas fonā: sāciet to, sekojiet tās progresam, pēc tam lejupielādējiet ZIP arhīvu.

Kā tas darbojas

1

Sāciet lielapjoma izveidi

Nosūtiet rindas ar Izveide no JSON vai Izveide no CSV faila. API atbild ar 202 un lielapjoma izveidi ar tās id.
2

Sekojiet progresam

Izsauciet Lielapjoma izveides iegūšana ik pēc dažām sekundēm, līdz status ir completed vai failed.
3

Lejupielādējiet arhīvu

Kad status ir completed, izsauciet Arhīva lejupielāde, lai iegūtu QR kodu attēlu ZIP.
  • Ierobežojums. Līdz 100 rindām vienā lielapjoma izveidē.
  • Pa vienai. Darbvietā vienlaikus darbojas tikai viena lielapjoma izveide. Mēģinot sākt citu, kamēr viena darbojas, tiek atgriezta jau notiekošā.
  • Idempotence. Katram pieprasījumam vajadzīgs idempotencyKey. Atkārtojot pieprasījumu ar to pašu atslēgu un to pašu pamattekstu, tiek atgriezta jau sāktā lielapjoma izveide. Tā pati atslēga ar citu pamattekstu atgriež 422.
  • Rindas. Katrai rindai vajadzīgs name un url. Skatiet Rindas.
  • Plāns. Lielapjoma izveide nav pieejama plānā Single QR: pieprasījums atgriež 403 exceeded_limit.

Rindas

  • Nosaukums. Kļūst par QR koda nosaukumu. Tiek apgriezts un saīsināts līdz 40 rakstzīmēm. Atkārtotiem nosaukumiem (neņemot vērā reģistru) tiek pievienots numurs: Menu, Menu 2, Menu 3.
  • URL. Kļūst par mērķi. Tam jābūt http vai https adresei ar īstu domēnu, piemēram, example.com/menu, un tajā nedrīkst būt atstarpju. URL bez shēmas saņem https://.
  • Tukšas rindas. Rindas bez nosaukuma un bez URL tiek izlaistas. Rinda, kurā ir tikai viens no tiem, tiek noraidīta.
Katrs QR kods ir website QR kods ar īso saiti. Skatiet QR kodu veidi.

Galvenes

string
obligāts
Bearer, kam seko jūsu API atslēga. Skatiet Autentifikācija.
string
application/json galapunktam Izveide no JSON, multipart/form-data galapunktam Izveide no CSV faila.

Lielapjoma izveides objekts

string
Lielapjoma izveides ID, piemēram, cm2k7x9qb0003ax8eb4f6gh2t.
string
queued, processing, packaging vai completed. Neveiksmīga vai pārtraukta lielapjoma izveide caur rollingBack nonāk statusā failed.
string
Avota faila nosaukums.
integer
Rindu skaits.
integer
Līdz šim izveidotie QR kodi.
integer
Līdz šim atveidotie QR kodu attēli.
integer
Kopējais progress, no 0 līdz 100. Izveide aizņem līdz 40, atveidošana līdz 90, pakošana ir 95, un completed ir 100.
boolean
true, ja notiekoša lielapjoma izveide 2 minūtes nav virzījusies uz priekšu. Turpiniet vaicāt: Lielapjoma izveides iegūšana restartē iestrēgušu lielapjoma izveidi.
object | null
Kad status ir failed: code un message. Pārtrauktai lielapjoma izveidei ir kods cancelled_by_user. Neveiksmīga lielapjoma izveide tiek atritināta, tāpēc neviens no tās QR kodiem netiek saglabāts.
string | null
Ceļš uz Arhīva lejupielāde, kad status ir completed.
string
Sākuma datums, ISO 8601.
string
Pēdējās atjaunināšanas datums, ISO 8601.
string | null
Pabeigšanas datums, ISO 8601.
string | null
Kļūmes datums, ISO 8601.

Pašreizējās lielapjoma izveides iegūšana

GET /api/v1/bulk-qr-creations Atgriež lielapjoma izveidi, kas jūsu darbvietā vēl darbojas. Ja neviena nedarbojas, tiek atgriezta pēdējā pabeigtā (completed vai failed), līdz tā tiek aizvērta: to dara tās arhīva lejupielāde vai aizvēršana informācijas panelī. Citādi tiek atgriezts null. Izmantojiet to, lai pēc restartēšanas atsāktu sekošanu.

Izveide no JSON

POST /api/v1/bulk-qr-creations Sāk lielapjoma izveidi no rindu saraksta. Atbild ar 202 Accepted. Lielapjoma izveide darbojas fonā.
object[]
obligāts
Izveidojamie QR kodi, līdz 100. Katra rinda ir { "name": "...", "url": "..." } un nepieņem citus laukus. Skatiet Rindas.
object
obligāts
Dizains, kas tiek piemērots katram QR kodam: styles, frameOptions un logoOptions, visi nav obligāti. Noklusējuma dizainam sūtiet {}. Citi lauki tiek noraidīti. Skatiet Pielāgošana.
string
obligāts
Nosaukums, kas redzams informācijas panelī un tiek izmantots arhīvam, no 1 līdz 255 rakstzīmēm.
string
obligāts
Jūsu atslēga šai lielapjoma izveidei, no 8 līdz 100 rakstzīmēm.

Izveide no CSV faila

POST /api/v1/bulk-qr-creations/csv Tāpat kā Izveide no JSON, bet rindas tiek pieņemtas kā CSV fails, kas nosūtīts kā multipart/form-data. Atbild ar 202 Accepted. Failam jābūt .csv ne lielākam par 1 000 000 baitiem. Tā galvenes rindai jābūt tieši name,url, un tai seko līdz 100 datu rindām. Skatiet CSV formāts.
file
obligāts
CSV fails.
string
obligāts
Dizaina objekts, serializēts kā JSON, piemēram, {"styles":{"dotsOptions":{"type":"rounded"}}}. Noklusējuma dizainam sūtiet {}.
string
obligāts
Jūsu atslēga šai lielapjoma izveidei, no 8 līdz 100 rakstzīmēm.
string
Nosaukums, kas redzams informācijas panelī un tiek izmantots arhīvam, līdz 255 rakstzīmēm. Noklusējums ir augšupielādētā faila nosaukums.

Lielapjoma izveides iegūšana

GET /api/v1/bulk-qr-creations/{id} Atgriež lielapjoma izveides statusu un progresu. Vaicājiet to, kamēr status ir queued, processing vai packaging. downloadUrl parādās, kad arhīvs ir gatavs.
string
obligāts
Lielapjoma izveides ID. Ņemiet to no izveides vai pašreizējās lielapjoma izveides atbildes.

Lielapjoma izveides pārtraukšana

DELETE /api/v1/bulk-qr-creations/{id} Aptur notiekošu lielapjoma izveidi un dzēš jau izveidotos QR kodus. Atritināšana notiek pieprasījuma laikā, tāpēc atbildē parasti ir status failed un error.code cancelled_by_user. Jau neveiksmīgas lielapjoma izveides pārtraukšana atgriež to nemainītu.
Pabeigtu lielapjoma izveidi nevar pārtraukt: pieprasījums atgriež 400. Tā vietā dzēsiet tās QR kodus pa vienam ar QR kodi.
string
obligāts
Lielapjoma izveides ID.

Arhīva lejupielāde

GET /api/v1/bulk-qr-creations/{id}/download Atgriež ZIP arhīvu ar vienu 1024 px JPEG katram QR kodam, nosauktu pēc tā rindas: 001-Menu.jpg, 002-Wine list.jpg un tā tālāk. Arhīvs tiek nosaukts pēc sourceFilename. Pieejams, kad status ir completed. Lejupielāde aizver lielapjoma izveidi, tāpēc Pašreizējās lielapjoma izveides iegūšana to vairs neatgriež.
string
obligāts
Lielapjoma izveides ID.

Biežākās problēmas

Ziņojumā norādīta rinda. Katram URL jābūt http vai https adresei ar īstu domēnu, piemēram, example.com/menu. Izlabojiet rindu un nosūtiet pieprasījumu vēlreiz.
CSV pirmajai rindai jābūt name,url tieši šādā secībā un mazajiem burtiem, bez citām kolonnām.
Atslēgas nevar atkārtoti izmantot citai partijai. Nosūtiet jaunu idempotencyKey.
Lielapjoma izveide vēl nav pabeigta. Turpiniet vaicāt, līdz status ir completed.
Lielapjoma izveide jau ir pabeigta, tāpēc to nevar atritināt.
Jūsu darbvieta izmanto plānu Single QR, kurā lielapjoma izveide nav iekļauta. Jauniniet plānu.
Jūsu darbvietā vēl darbojas cita lielapjoma izveide, vai jūs atkārtoti izmantojāt idempotencyKey. Pagaidiet, līdz tā beidzas, vai izmantojiet jaunu atslēgu.

Kas tālāk

Pielāgošana

QR kodi

Lielapjoma izveide lietotnē

CSV formāts