API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
Cum funcționează
1
Porniți crearea în masă
Trimiteți rândurile cu Crearea din JSON sau Crearea dintr-un fișier CSV. API-ul răspunde cu
202, crearea în masă și id-ul ei.2
Urmăriți progresul
Apelați Obținerea unei creări în masă la câteva secunde, până când
status este completed sau failed.3
Descărcați arhiva
Când
status este completed, apelați Descărcarea arhivei pentru a obține un ZIP cu imaginile codurilor QR.- Limită. Până la 100 de rânduri per creare în masă.
- Una singură odată. Într-un spațiu de lucru rulează o singură creare în masă. Dacă porniți alta cât timp una rulează, primiți înapoi pe cea care rulează.
- Idempotență. Fiecare cerere necesită un
idempotencyKey. Dacă repetați o cerere cu aceeași cheie și același corp, primiți crearea în masă deja pornită. Aceeași cheie cu un alt corp returnează422. - Rânduri. Fiecare rând are nevoie de
nameșiurl. Consultați Rânduri. - Plan. Crearea în masă nu este disponibilă pe planul Single QR: cererea returnează
403 exceeded_limit.
Rânduri
- Nume. Devine titlul codului QR. Spațiile de la capete sunt eliminate, iar numele este trunchiat la 40 de caractere. Numele repetate (indiferent de majuscule) primesc un număr:
Menu,Menu 2,Menu 3. - URL. Devine destinația. Trebuie să fie o adresă
httpsauhttpscu un domeniu real, cum ar fiexample.com/menu, și să nu conțină spații. Un URL fără schemă primeștehttps://. - Rânduri goale. Rândurile fără nume și fără URL sunt omise. Un rând care are doar unul dintre ele este respins.
website cu link scurt. Consultați Tipuri de coduri QR.
Anteturi
string
obligatoriu
Bearer urmat de cheia dvs. API. Consultați Autentificare.string
application/json pentru Crearea din JSON, multipart/form-data pentru Crearea dintr-un fișier CSV.Obiectul creare în masă
string
ID-ul creării în masă, de exemplu
cm2k7x9qb0003ax8eb4f6gh2t.string
queued, processing, packaging sau completed. O creare în masă eșuată sau anulată trece prin rollingBack până la failed.string
Numele fișierului sursă.
integer
Numărul de rânduri.
integer
Codurile QR create până acum.
integer
Imaginile codurilor QR randate până acum.
integer
Progresul total, de la 0 la 100. Crearea ajunge până la 40, randarea până la 90, împachetarea este 95, iar
completed este 100.boolean
true când o creare în masă care rulează nu a mai progresat de 2 minute. Continuați să interogați: Obținerea unei creări în masă repornește o creare în masă blocată.object | null
Când
status este failed: code și message. O creare în masă anulată are codul cancelled_by_user. O creare în masă eșuată este anulată integral, așa că niciunul dintre codurile ei QR nu este păstrat.string | null
Calea pentru Descărcarea arhivei, după ce
status este completed.string
Data pornirii, ISO 8601.
string
Data ultimei actualizări, ISO 8601.
string | null
Data finalizării, ISO 8601.
string | null
Data eșecului, ISO 8601.
Obținerea creării în masă curente
GET /api/v1/bulk-qr-creations
Returnează crearea în masă care încă rulează în spațiul dvs. de lucru. Când nu rulează niciuna, returnează ultima creare încheiată (completed sau failed) până când aceasta este închisă: descărcarea arhivei sau închiderea ei în panou are acest efect. Altfel, returnează null. Folosiți-l pentru a relua urmărirea după o repornire.
Crearea din JSON
POST /api/v1/bulk-qr-creations
Pornește o creare în masă dintr-o listă de rânduri. Răspunde cu 202 Accepted. Crearea în masă rulează în fundal.
object[]
obligatoriu
Codurile QR de creat, până la 100. Fiecare rând este
{ "name": "...", "url": "..." } și nu acceptă alte câmpuri. Consultați Rânduri.object
obligatoriu
Designul aplicat fiecărui cod QR:
styles, frameOptions și logoOptions, toate opționale. Trimiteți {} pentru designul implicit. Alte câmpuri sunt respinse. Consultați Personalizare.string
obligatoriu
Numele afișat în panou și folosit pentru arhivă, între 1 și 255 de caractere.
string
obligatoriu
Propria dvs. cheie pentru această creare în masă, între 8 și 100 de caractere.
Crearea dintr-un fișier CSV
POST /api/v1/bulk-qr-creations/csv
La fel ca Crearea din JSON, dar primește rândurile ca fișier CSV trimis ca multipart/form-data. Răspunde cu 202 Accepted.
Fișierul trebuie să fie un .csv de cel mult 1.000.000 de octeți. Rândul de antet trebuie să fie exact name,url, urmat de cel mult 100 de rânduri de date. Consultați Formatul CSV.
file
obligatoriu
Fișierul CSV.
string
obligatoriu
Obiectul de design, serializat ca JSON, de exemplu
{"styles":{"dotsOptions":{"type":"rounded"}}}. Trimiteți {} pentru designul implicit.string
obligatoriu
Propria dvs. cheie pentru această creare în masă, între 8 și 100 de caractere.
string
Numele afișat în panou și folosit pentru arhivă, până la 255 de caractere. Implicit, numele fișierului încărcat.
Obținerea unei creări în masă
GET /api/v1/bulk-qr-creations/{id}
Returnează starea și progresul unei creări în masă. Interogați-l cât timp status este queued, processing sau packaging. downloadUrl apare când arhiva este gata.
string
obligatoriu
ID-ul creării în masă. Preluați-l din răspunsul creării sau din cel al creării în masă curente.
Anularea unei creări în masă
DELETE /api/v1/bulk-qr-creations/{id}
Oprește o creare în masă care rulează și șterge codurile QR pe care le-a creat deja. Anularea modificărilor are loc în timpul cererii, așa că, în mod normal, răspunsul are status failed și error.code cancelled_by_user. Anularea unei creări în masă care a eșuat deja o returnează neschimbată.
string
obligatoriu
ID-ul creării în masă.
Descărcarea arhivei
GET /api/v1/bulk-qr-creations/{id}/download
Returnează o arhivă ZIP cu câte un JPEG de 1024 px pentru fiecare cod QR, denumit după rândul său: 001-Menu.jpg, 002-Wine list.jpg și așa mai departe. Arhiva este denumită după sourceFilename. Disponibilă după ce status este completed. Descărcarea închide crearea în masă, așa că Obținerea creării în masă curente nu o mai returnează.
string
obligatoriu
ID-ul creării în masă.
Probleme frecvente
422 cu "contains an invalid HTTP(S) URL"
422 cu "contains an invalid HTTP(S) URL"
Mesajul indică rândul. Fiecare URL trebuie să fie o adresă
http sau https cu un domeniu real, cum ar fi example.com/menu. Corectați rândul și trimiteți din nou cererea.422 "CSV headers must be exactly: name,url."
422 "CSV headers must be exactly: name,url."
Primul rând al fișierului CSV trebuie să fie
name,url, în această ordine și cu litere mici, fără alte coloane.422 "This idempotencyKey was already used with a different request body."
422 "This idempotencyKey was already used with a different request body."
Cheile nu pot fi refolosite pentru un alt lot. Trimiteți un
idempotencyKey nou.409 "The bulk QR archive is not ready for download."
409 "The bulk QR archive is not ready for download."
Crearea în masă nu s-a finalizat încă. Continuați să interogați până când
status este completed.400 "Cannot cancel a finished bulk QR creation."
400 "Cannot cancel a finished bulk QR creation."
Crearea în masă s-a finalizat deja, așa că nu mai poate fi anulată.
403 exceeded_limit
403 exceeded_limit
Spațiul dvs. de lucru folosește planul Single QR, care nu include crearea în masă. Treceți la un plan superior.
Am primit o creare în masă mai veche în locul uneia noi
Am primit o creare în masă mai veche în locul uneia noi
O altă creare în masă încă rulează în spațiul dvs. de lucru sau ați refolosit un
idempotencyKey. Așteptați să se termine sau folosiți o cheie nouă.