API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.
qrType, a typ określa, co musi zawierać data. Ten przewodnik opisuje format każdego typu, działającą treść żądania i to, co możesz zmienić po wydrukowaniu kodu.
Przykłady to treści żądań dla tworzenia kodu QR. Wysyłaj je tak:
Wszystkie typy w skrócie
Jak rozwiązywany jest kod QR
Każdy kod QR to krótki link plus dane. Treść przenoszą dwa pola:
Reguły dla wszystkich typów:
- Wartości domyślne. Przy tworzeniu pominięty lub pusty
link.urlprzyjmuje wartośćdata, a cały obiektlinkmożna pominąć. Gdy wyślesz oba i się różnią, wygrywalink.url. Wysyłaj je z tą samą wartością albo wyślij tylkodata. - Co koduje obraz. We wszystkich typach oprócz
wifiobraz koduje krótki link. Dzięki temu możesz zmienić, dokąd prowadzi wydrukowany kod, a jego skanowania są śledzone. Kod QR WiFi koduje samą sieć: po wydrukowaniu nie da się go zmienić, a jego skanowania nie są śledzone. - Schematy.
link.urlprzyjmuje tylkohttp:,https:,wifi:,mailto:,sms:ibegin:. Wszystko inne, w tymgeo:,smsto:,matmsg:itel:, dostaje422 Invalid destination URL, nawet jeślidatato przyjmuje. - Puste dane. Puste
datapomija sprawdzenie typu. Dla typu z przekierowaniem trzeba wtedy ustawićlink.url, inaczej wywołanie dostaje400 Missing destination URL. - Struktura. Poza sprawdzeniem typu serwer nie waliduje danych. Typ JSON musi jedynie dać się sparsować jako obiekt JSON, a vCard musi tylko zaczynać się od
BEGIN:VCARD.
Website
qrType: "website". Przewodnik po panelu: Kod QR Website.
Request body
422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".422 Invalid destination URL
Feedback
qrType: "feedback". Przewodnik po panelu: Kod QR Feedback.
data to adres URL http(s) formularza opinii, np. Google Form lub strony z recenzjami. Wszystko inne działa jak w typie Website.
Request body
Payment
qrType: "payment". Przewodnik po panelu: Kod QR Payment.
data to adres URL płatności u dostawcy, np.:
paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link i payoneer.com. W przypadku PayPal kwota jest ostatnim segmentem ścieżki. Działa też każdy inny adres URL http(s), ale kreator nie rozdzieli go na dostawcę i kwotę. Wszystko inne działa jak w typie Website.
Request body
qrType: "whatsapp". Przewodnik po panelu: Kod QR WhatsApp.
data to link wa.me: numer międzynarodowy w cyfrach bez +, opcjonalnie ze wstępnie wypełnionym tekstem.
api.whatsapp.com/send. Wszystko inne działa jak w typie Website.
Request body
Location
qrType: "location". Przewodnik po panelu: Kod QR Location.
data to adres URL mapy. Użyj tego formatu, aby kod QR dało się edytować w panelu (query_place_id jest opcjonalny):
geo: przechodzi sprawdzenie data, ale jest odrzucany jako cel, więc go nie używaj. Wszystko inne działa jak w typie Website.
Request body
App Link
qrType: "app". Przewodnik po panelu: Kod QR App Link.
Request body
422 Invalid URL400 Missing destination URL
qrType: "email". Przewodnik po panelu: Kod QR Email.
Request body
422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".
SMS
qrType: "sms". Przewodnik po panelu: Kod QR SMS.
Request body
422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".
WiFi
qrType: "wifi". Przewodnik po panelu: Kod QR WiFi.
Request body
422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
PDF, Image i Video
qrType: "pdf", "image" lub "video". Przewodniki po panelu: PDF, Image, Video.
Jeden plik na kod QR: pakiety PDF i galerie obrazów nie są dostępne w API. Zobacz Nieobsługiwane przez API.
fileId, opisuje strona Pliki.
vCard
qrType: "vcard". Przewodnik po panelu: Kod QR vCard.
Strona docelowa i kreator odczytują tylko poniższe postacie wierszy. Inne warianty, takie jak
TEL;CELL: czy EMAIL;TYPE=INTERNET:, są zapisywane, ale nie pojawiają się na stronie.
N:<last>;<first>;;;: nazwisko i imię. Kreator: oba wymagane, do 40 znaków.FN:<first> <last>: nieodczytywane przez stronę. Z niego pochodzi etykieta na liście w panelu.ORG:<company>iTITLE:<role>: firma i stanowisko. Kreator: do 40 znaków.TEL;TYPE=HOME:,TEL;TYPE=CELL:,TEL;TYPE=WORK:,TEL;TYPE=FAX:: numery telefonu, komórki, służbowy i faksu (+i cyfry).EMAIL:<email>: adres e-mail.URL:<url>: strona internetowa.NOTE:<text>: podsumowanie. Stosuj znaki ucieczki\\,\n,\;i\,. Kreator: do 200 znaków.ADR:;;<street>;<city>;<state>;<zip>;<country>: adres.X-SOCIALPROFILE;TYPE=<platform>:<url>lubURL;TYPE=<PLATFORM>:<url>: linki do mediów społecznościowych, jeden wiersz na serwis.PHOTO;VALUE=URI:<url>: adres URL zdjęcia profilowego. Ma pierwszeństwo przed każdym ID pliku.X-GETQR-IMAGE-FILEID:<fileId>: zdjęcie profilowe (targetlogo).X-GETQR-PAGE-LOGO-FILEID:<fileId>: logo strony (targetlogo).X-GETQR-LANDING-THEME:p|<0-4>lubX-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: motyw strony docelowej, czyli indeks gotowego motywu (od 0 do 4) albo własne kolory tła, przycisku i ikon.
facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".
Social Media
qrType: "social". Przewodnik po panelu: Kod QR Social Media.
Pola w
data:
Request body
422 Expected a JSON object describing the social profile page for qrType "social".
Multi-Link
qrType: "multilink". Przewodnik po panelu: Kod QR Multi-Link.
Pola w
data są takie same jak w typie Social Media, z tą różnicą, że firstName, lastName i summary zastępują:
W
customItems pole logoFileId jest opcjonalne: wyświetlana jest ikona zastępcza. Kreator: co najmniej jeden link społecznościowy lub jeden niepusty własny element.
Request body
422 Expected a JSON object describing the multi-link page for qrType "multilink".
Event
qrType: "event". Przewodnik po panelu: Kod QR Event.
Pola w
data:
Typy wydarzeń
Typy wydarzeń
conference, seminar, workshop, training, webinar, meetup, networking, corporateEvent, productLaunch, tradeShow, jobFair, fundraiser, charity, wedding, engagement, birthday, anniversary, babyShower, graduation, reunion, party, religious, funeralMemorial, ceremony, concert, festival, clubNight, theater, comedy, filmScreening, exhibition, sports, tournament, raceMarathon, fitnessClass, foodDrink, market, openHouse, community, schoolEvent, kids, travelTourUdogodnienia
Udogodnienia
Request body
422 Expected a JSON object describing the event page for qrType "event".
Pliki w kodach QR
Zarejestruj plik przez Pliki, prześlij go, a następnie przekaż jegofileId. Użyj celu (target) odpowiadającego zastosowaniu:
pdf,image,video. Treść kodu QR typu PDF, Image lub Video.logo. Zdjęcia profilowe, logo stron, ikony własnych linków i logo na środku kodu.
fileId zwracane przy tworzeniu oraz przy PATCH, gdy wysłano fileId:
ID plików wewnątrz danych (
fileId, pageLogoFileId, customItems[].logoFileId, wiersze X-GETQR-*-FILEID) nie są sprawdzane. Wyświetlają się tylko wtedy, gdy przesłano je z celem logo. Kod QR przejmuje je na własność, więc czyszczenie ich nie usuwa.
Zmiana typu
Możesz zmienićqrType za pomocą aktualizacji kodu QR. Wyślij data pasujące do nowego typu: zapisane dane należą do starego typu, więc zmiana bez nich jest odrzucana.
Po aktualizacji cel jest ustalany w tej kolejności:
vcard,social,multilink,event: zawsze hostowana strona.- Pakiet PDF lub galeria obrazów utworzone w panelu: ich strona docelowa.
pdf,image,video: adres URL pliku (nowegofileId, a w przeciwnym razie zapisanego).link.url, jeśli został wysłany.- Zmienione
data. - Zapisany adres URL.
- Z
pdf,imagelubvideo.fileIdoraz ewentualny pakiet lub galeria są czyszczone. - Na
pdf,imagelubvideo. Wyślij teżfileId, inaczej zostanie ponownie użyty zapisany plik, którym może być zdjęcie vCard. - Z
app. Nazwa aplikacji,link.iosilink.androidsą czyszczone, więc telefony trafiają do nowego celu. - Na
wifi. Obraz przełącza się na surowe dane. Już wydrukowane kody nadal zawierają krótki link, który teraz przekierowuje na adres URLwifi:. - Z
wifi. Wydrukowane kody zachowują starą sieć. - Na
vcard,social,multilinklubevent. Krótki link zaczyna wskazywać nową hostowaną stronę. - Z
vcard,social,multilinklubevent. Wyślij nowedata. Cel się do nich dostosuje.
link.url dostaje 422.
Nieobsługiwane przez API
Te funkcje panelu nie są częścią API v1. Nieznane pola są pomijane bez błędu, więc ich wysłanie nic nie zmienia.
Pakiety i galerie utworzone w panelu można nadal odczytywać, wstrzymywać i usuwać przez API, ale nie można przez nie zmieniać ich plików.
Typowe problemy
422 Invalid destination URL
422 Invalid destination URL
link.url używa schematu, do którego krótki link nie może przekierować, np. geo:, smsto:, matmsg: lub tel:. Użyj formatów opisanych na tej stronie.400 Missing destination URL
400 Missing destination URL
data jest puste i nie ma link.url. Dla app ustaw co najmniej jedno z link.ios, link.android, link.url lub data.Pole data w odpowiedzi to krótki link, a nie mój adres URL
Pole data w odpowiedzi to krótki link, a nie mój adres URL
W typach z linkiem zapisane
data to krótki link. Cel odczytuj z url.Na stronie docelowej brakuje informacji z moich danych
Na stronie docelowej brakuje informacji z moich danych
Strona odczytuje tylko pola i postacie wierszy wymienione dla danego typu. Inne pola są zapisywane, ale niewyświetlane.