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.
QR kods GetQR ir attēls kopā ar īso saiti, caur kuru tas novirza. Izveidojot QR kodu, tiek izveidota arī tā īsā saite, tāpēc vēlāk varat mainīt mērķi, nepārdrukājot kodu.

QR koda dati pēc veida

data formāts katram no 16 veidiem.

Pielāgošana

Punktu stili, krāsas, rāmji un logotipi.

Piekļuves noteikumi

Grafiks, skenējumu ierobežojums un parole.
QR koda skenēšanas statistiku skatiet sadaļā Analītika.

QR koda objekts

Visi QR kodu galapunkti atbild ar šo objektu, izņemot dzēšanu un lejupielādi. Saraksts atgriež šādu objektu masīvu.
string
Unikāls QR koda ID, piemēram, qr_1EPcVfeHZAY2iNoVLsgW2Aqf.
string
QR koda veids, piemēram, website. Visas 16 vērtības skatiet sadaļā QR koda dati pēc veida.
string | null
QR koda nosaukums, kas redzams informācijas panelī.
string | null
Brīva teksta piezīme par QR kodu.
string
Saglabātais saturs. Veidiem wifi, vcard, social, multilink, event un sms tas ir jūsu nosūtītais saturs. Visiem pārējiem veidiem tā ir īsā saite, tāpēc mērķi nolasiet no url.
boolean
true, ja QR kods ir pauzēts.
boolean
true statiskam QR kodam, kas izveidots informācijas panelī un kam nav īsās saites. API vienmēr izveido dinamiskus QR kodus.
Pilna īsā saite, piemēram, https://getqr.sh/x7Kd2p1.
string | null
Īsās saites domēns.
string | null
Īsās saites slug.
boolean
true, ja slug tika izvēlēts, nevis ģenerēts.
string | null
Mērķis, uz kuru novirza īsā saite.
string | null
Mērķis iOS apmeklētājiem app QR kodiem.
string | null
Mērķis Android apmeklētājiem app QR kodiem.
integer
Kopējais skenējumu skaits.
object
Piekļuves noteikumi. Pati parole nekad netiek atgriezta. Skatiet Piekļuves noteikumi.
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. API nevar rediģēt tā attēlu, bet saglabā to, kad maināt citus laukus.
object
Saglabātais dizains: styles, frameOptions un logoOptions, katrs ir objekts vai null. Tiem ir tāda pati forma kā pieprasījuma laukiem, tāpēc varat tos nosūtīt atpakaļ. Skatiet Pielāgošana.
object | null
pdf, image vai video QR koda fails: id, name un size baitos.
string | null
Tikai lasāms. Informācijas panelī izveidota app QR koda attēlotais nosaukums.
object | null
Tikai lasāms. Informācijas panelī izveidots pdf QR kods ar vairākiem failiem: title, layout un files.
Tikai lasāms. Informācijas panelī izveidots image QR kods ar vairākiem attēliem: title, layout un files.
string
Izveides datums, ISO 8601.
string
Pēdējās atjaunināšanas datums, ISO 8601.
Noslēpumi un iekšējie ID (password, userId, workspaceId, projectId) nekad netiek atgriezti.

QR kodu saraksts

GET /api/v1/qrs Atgriež jūsu darbvietas QR kodus pa vienai lapai.
integer
noklusējums:"1"
Atgriežamā lapa, 1 vai vairāk.
integer
noklusējums:"100"
QR kodi lapā, no 1 līdz 100. Lielāka vērtība tiek noraidīta.
Meklē QR koda nosaukumā. Vaicājumi, kas garāki par 2 rakstzīmēm, meklē arī saglabātajā data. Saišu veidiem saglabātais data ir īsā saite, tāpēc mērķa URL meklēšanā netiek atrasti.
string
noklusējums:"createdAt"
Kārtošanas lauks: createdAt, updatedAt, clicks (kopējie skenējumi), lastClicked (pēdējais skenējums) vai type. type vienmēr kārto dilstošā secībā un ignorē sortOrder.
string
noklusējums:"desc"
Kārtošanas virziens: asc vai desc.
boolean
noklusējums:"false"
Iekļaut pauzētus QR kodus.
boolean
noklusējums:"false"
Atgriezt tikai pauzētus QR kodus. Ignorē showArchived.
Būla parametri pieņem virknes true vai false. Pieprasiet nākamo lapu, kamēr pagination.hasMore ir true. Skatiet Lapošana.

QR koda izveide

POST /api/v1/qrs Izveido QR kodu kopā ar tā īso saiti. Atbild ar 201 Created un jauno QR kodu.
string
Jūsu atkārtojuma marķieris. Atkārtojot pieprasījumu ar to pašu atslēgu 24 stundu laikā, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs QR kods. Skatiet Atkārtojumi un dublikāti.
string
obligāts
Ko QR kods kodē. Tas nosaka arī formātu, kādā jābūt data. Viens no website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.
string
obligāts
Veida saturs, kas tiek pārbaudīts pret qrType. Tukša virkne izlaiž pārbaudi. Katra veida formāts ir aprakstīts sadaļā QR koda dati pēc veida.
Īsā saite, caur kuru QR kods novirza. Nav obligāts: ja izlaists, link.url seko data.
string
QR koda nosaukums, kas redzams informācijas panelī. Apgriezts, no 1 līdz 40 rakstzīmēm. Ja izlaists, QR kodam nav nosaukuma.
string
Brīva teksta piezīme par QR kodu. Līdz 280 rakstzīmēm.
string
pdf, image vai video QR koda fails, kas augšupielādēts ar atbilstošo target. Veidiem vcard, social un multilink — neobligāts profila attēls, kas augšupielādēts ar target logo. event to arī pieņem, bet tā lapa vāka attēlu nolasa no data.fileId. Citi veidi saņem 422. Vispirms augšupielādējiet failu ar Faili. Skatiet Faili QR kodos.
string
Veidne, kuras dizains tiek piemērots jaunajam QR kodam. Nosūtītie dizaina lauki tiek apvienoti virs tās. Branded vai AI dizaina veidne saņem 422 (art_template_unsupported). Nezināma veidne vai veidne no citas darbvietas saņem 404.
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 target logo. Nezināms fails, nepabeigta augšupielāde vai cita target fails tiek noraidīts. Skatiet Pielāgošana.
object
Grafiks, skenējumu ierobežojums un paroles aizsardzība. Skatiet Piekļuves noteikumi.
boolean
Vai QR kods ir pauzēts. true izveido to pauzētu: skenējumi rāda pauzes lapu, nevis mērķi.
Nezināmi lauki tiek izmesti bez kļūdas. Skatiet Nav pieejams API.

Atkārtojumi un dublikāti

  • Ar atslēgu. Ar galveni Idempotency-Key atbilde tiek atkārtota 24 stundas.
  • Bez atslēgas. Identisks pamatteksts, kas nosūtīts 30 sekunžu laikā, tiek uzskatīts par dublikātu.
  • Atkārtotas atbildes. Atkārtota atbilde atgriež saglabāto atbildi ar x-idempotent-replay: true. Jauns QR kods atgriež false.
  • Apstrādē. Otrs pieprasījums, kamēr pirmais vēl tiek apstrādāts, saņem 409 conflict.
  • Kļūmes. Neveiksmīga izveide atslēgu atbrīvo uzreiz, tāpēc varat mēģināt vēlreiz ar to pašu atslēgu.
  • Pēc labākās iespējas. Ja aizsardzība nav pieejama, izveide notiek bez tās.
Skatiet arī Idempotence.

QR koda iegūšana

GET /api/v1/qrs/{qrId} Atgriež QR kodu ar tā īso saiti, piekļuves noteikumiem, dizainu un, failu veidiem, tā failu.
string
obligāts
QR koda ID no saraksta vai izveides atbildes.
Atbilde ir pilns QR koda objekts.

QR koda atjaunināšana

PATCH /api/v1/qrs/{qrId} Maina QR koda saturu, mērķi, dizainu vai piekļuves noteikumus. Sūtiet tikai tos laukus, kurus vēlaties mainīt. Atbild ar atjaunināto QR kodu.
string
obligāts
QR koda ID.
Pamatteksts pieņem tos pašus laukus kā QR koda izveide, visi nav obligāti, ar šādām atšķirībām:
  • templateId. Netiek pieņemts.
  • link. Daļējs. Ja izlaižat link.url, pašreizējais mērķis tiek saglabāts. link.domain un link.key saņem 422: izdrukātais kods kodē tieši īso saiti, tāpēc, lai izmantotu citu, izveidojiet jaunu QR kodu.
  • data. Tiek pārbaudīts pret iegūto veidu tikai tad, ja mainās data vai qrType. qrType maiņa bez atbilstoša data tiek noraidīta. Skatiet Veida maiņa.
  • Dizains. styles, frameOptions un logoOptions tiek apvienoti ar saglabāto dizainu, tāpēc daļējs objekts maina tikai to, ko tas norāda. Izvēloties citu logotipu, tas tiek aizstāts, bet tā izmērs paliek.
  • access. Katra atslēga tiek piemērota, ja tā ir norādīta. null noņem noteikumu. Piekļuves noteikumi pieder objektam access: nosūtot tos objektā link, tiek atgriezts 422.
  • archived. Pauzē vai atkārtoti aktivizē QR kodu kopā ar tā īso saiti, tāpat kā pauzēšana un atkārtota aktivizēšana.
Ko katrs veids ļauj mainīt pēc izdrukāšanas, skatiet sadaļā QR koda dati pēc veida.

Pauzes stāvokļa iestatīšana

PUT /api/v1/qrs/{qrId} Tieši iestata pauzes stāvokli. Pauzēšana un atkārtota aktivizēšana dara to pašu un ir vieglāk saprotamas.
string
obligāts
QR koda ID.
boolean
obligāts
true, lai pauzētu QR kodu, false, lai to atkārtoti aktivizētu.

QR koda pauzēšana

POST /api/v1/qrs/{qrId}/pause Aptur QR koda novirzīšanu uz mērķi: skenējumi tā vietā rāda pauzes lapu. Izdrukātais kods un tā īsā saite paliek derīgi. Bez pieprasījuma pamatteksta.
string
obligāts
QR koda ID.

QR koda atkārtota aktivizēšana

POST /api/v1/qrs/{qrId}/activate Pauzēts QR kods atkal novirza uz savu mērķi. Grafiks un skenējumu ierobežojums joprojām ir spēkā. Bez pieprasījuma pamatteksta.
string
obligāts
QR koda ID.

QR koda dublēšana

POST /api/v1/qrs/{qrId}/duplicate Izveido kopiju ar tādu pašu saturu un dizainu. Bez pieprasījuma pamatteksta. Atbild ar 201 Created un jauno QR kodu.
string
obligāts
Kopējamā QR koda ID.
  • Īsā saite. Kopija saņem savu īso saiti ar nejaušu slug darbvietas noklusējuma domēnā, nevis oriģināla domēnā. Tās skenējumi tiek skaitīti atsevišķi.
  • Nosaukums. Nosaukumam tiek pievienots sufikss (Copy). Rezultāts nepārsniedz 40 rakstzīmes: garš nosaukums vispirms tiek saīsināts. QR kods bez nosaukuma paliek bez nosaukuma.
  • Netiek kopēts. Piekļuves noteikumi (parole, grafiks, skenējumu ierobežojums) un pauzes stāvoklis. Kopija vienmēr ir aktīva.
  • Faili. PDF un attēlu faili, ieskaitot komplektu un galeriju failus, tiek kopēti, tāpēc tie pieder kopijai. Video faili un dizaina faili, piemēram, logotipi, tiek kopīgoti ar oriģinālu.

QR koda dzēšana

DELETE /api/v1/qrs/{qrId} Dzēš QR kodu un tā īso saiti. Atbild ar dzēstā koda ID.
Dzēšana ir neatgriezeniska. Izdrukātais kods un tā īsā saite pārstāj darboties, un skenējumu vēsture vairs nav pieejama. Ja QR kods vēl var būt vajadzīgs, pauzējiet to.
string
obligāts
QR koda ID.
string
Dzēstā QR koda ID.
boolean
Vienmēr true.

QR koda attēla lejupielāde

GET /api/v1/qrs/{qrId}/download Atveido QR kodu ar tā dizainu un atgriež failu.
string
obligāts
Atveidojamā QR koda ID no saraksta vai izveides atbildes.
string
noklusējums:"jpg"
Izvades formāts: jpg, png, svg, pdf (A4 lapa) vai eps. Branded vai AI dizainu var lejupielādēt tikai kā jpg, png vai pdf.
integer
noklusējums:"1024"
Attēla izmērs pikseļos: 1024, 2048 vai 4096. svg un pdf to ignorē. Branded vai AI dizainu var lejupielādēt tikai ar 1024.
  • Pamatteksts. Atbildes pamatteksts ir pats fails. Ieteiktais faila nosaukums ir galvenē Content-Disposition, veidots no nosaukuma vai qr-code QR kodam bez nosaukuma.
  • Kešošana. Atbildes satur ETag un Cache-Control: private, max-age=3600, must-revalidate. Nosūtiet ETag atpakaļ galvenē If-None-Match, lai saņemtu 304 Not Modified, ja QR kods nav mainījies.
  • Kļūdas. Neatbalstīts formāts vai izšķirtspēja saņem 400 bad_request. Kļūdas ziņojumā norādīts iemesls: qr_download_invalid_format, qr_download_invalid_resolution, qr_download_art_format_unsupported vai qr_download_art_resolution_unsupported.

Piekļuves noteikumi

Izveidojot vai atjauninot sūtiet objektu access, lai ieplānotu sākumu un beigas, ierobežotu skenējumu skaitu vai pieprasītu paroli. Izlaistie noteikumi paliek nemainīti, un null noņem noteikumu. Pilns apraksts ar piemēriem ir sadaļā Piekļuves noteikumi.

Dizaina objekti

styles, frameOptions un logoOptions nosaka punktu un stūru formas, krāsas, rāmi un logotipu. Tie darbojas vienādi QR kodiem, veidnēm un lielapjoma izveidei. Nezināmas formas, rāmji vai logotipi tiek noraidīti. Visas pieņemtās vērtības un izstrādāts piemērs ir sadaļā Pielāgošana.

Biežākās problēmas

Sūtiet noteikumu objektā access, nevis objektā link.
data neatbilst qrType formātam. Pārbaudiet veidu sadaļā QR koda dati pēc veida.
Identiska izveide vēl tiek apstrādāta, vai link.key ir aizņemts. Mēģiniet vēlreiz, kad pirmais pieprasījums ir pabeigts. Ar Idempotency-Key atkārtojums atgriež sākotnējo QR kodu.
Parametri ir format un resolution, un format noklusējums ir jpg. Sūtiet format=png.
Katrs pieprasījums tiek izpildīts jūsu API atslēgas darbvietā. Pārbaudiet, vai QR kods pieder tai. Skatiet Autentifikācija.

Kas tālāk

QR koda dati pēc veida

Pielāgošana

Piekļuves noteikumi

Analītika