메인 콘텐츠로 건너뛰기
GetQR API는 베타 버전이며 일부 워크스페이스에서만 사용할 수 있습니다. 정식 출시 전에 세부 사항이 변경될 수 있습니다.
모든 QR 코드에는 qrType이 있으며, 유형에 따라 data에 담아야 할 내용이 정해집니다. 이 가이드에서는 모든 유형의 형식, 그대로 사용할 수 있는 요청 본문, 코드를 인쇄한 후에도 변경할 수 있는 항목을 설명합니다. 예시는 QR 코드 생성의 요청 본문입니다. 다음과 같이 보내세요.

전체 유형 한눈에 보기

QR 코드가 연결되는 방식

모든 QR 코드는 단축 링크와 페이로드로 이루어집니다. 콘텐츠를 담는 필드는 두 가지입니다. 모든 유형에 적용되는 규칙:
  • 기본값. 생성 시 link.url을 생략하거나 비워 두면 data가 사용되며, link 객체 전체를 생략해도 됩니다. 둘 다 보냈는데 값이 다르면 link.url이 우선합니다. 같은 값을 보내거나 data만 보내세요.
  • 이미지에 인코딩되는 내용. wifi를 제외한 모든 유형에서 이미지는 단축 링크를 인코딩합니다. 따라서 인쇄된 코드의 목적지를 바꿀 수 있고 스캔도 추적됩니다. WiFi QR 코드는 네트워크 자체를 인코딩하므로 인쇄 후에는 변경할 수 없고 스캔도 추적되지 않습니다.
  • 스킴. link.url은 http:, https:, wifi:, mailto:, sms:, begin:만 받습니다. geo:, smsto:, matmsg:, tel:을 포함한 그 밖의 스킴은 data에서 허용되더라도 422 Invalid destination URL을 반환합니다.
  • 빈 data. data가 비어 있으면 유형 검사를 건너뜁니다. 이때 리디렉션 유형은 link.url을 설정해야 하며, 그렇지 않으면 400 Missing destination URL을 반환합니다.
  • 구조. 서버는 유형 검사 외에는 페이로드를 검증하지 않습니다. JSON 유형은 JSON 객체로 파싱되기만 하면 되고, vCard는 BEGIN:VCARD로 시작하기만 하면 됩니다.
아래에서 빌더로 표시한 제한은 대시보드 빌더가 적용하는 제한입니다. API는 이를 무시한 페이로드도 받지만, 랜딩 페이지나 빌더에서 이상하게 표시될 수 있습니다.

Website

qrType: "website". 대시보드 가이드: Website QR 코드.
Request body
오류:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Feedback

qrType: "feedback". 대시보드 가이드: Feedback QR 코드. data는 피드백 양식의 http(s) URL입니다. 예를 들어 Google Forms나 리뷰 페이지입니다. 나머지는 모두 Website와 같습니다.
Request body

Payment

qrType: "payment". 대시보드 가이드: Payment QR 코드. data는 결제 서비스의 결제 URL입니다. 예:
대시보드 빌더는 다음 호스트를 인식합니다: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link, payoneer.com. PayPal의 경우 금액은 경로의 마지막 세그먼트입니다. 다른 http(s) URL도 작동하지만 빌더가 결제 서비스와 금액으로 나누어 표시하지는 않습니다. 나머지는 모두 Website와 같습니다.
Request body

WhatsApp

qrType: "whatsapp". 대시보드 가이드: WhatsApp QR 코드. data는 wa.me 링크입니다. + 없이 숫자로만 된 국제 전화번호를 사용하며, 필요하면 미리 입력할 텍스트를 붙입니다.
서버는 http(s) URL인지만 확인합니다. 대시보드는 api.whatsapp.com/send 링크도 읽습니다. 나머지는 모두 Website와 같습니다.
Request body

Location

qrType: "location". 대시보드 가이드: Location QR 코드. data는 지도 URL입니다. 대시보드에서 QR 코드를 계속 수정할 수 있게 하려면 다음 형식을 사용하세요(query_place_id는 선택 사항).
다른 http(s) URL도 리디렉션됩니다. geo: URI는 data 검사는 통과하지만 목적지로는 거부되므로 사용하지 마세요. 나머지는 모두 Website와 같습니다.
Request body
qrType: "app". 대시보드 가이드: App Link QR 코드.
Request body
오류:
  • 422 Invalid URL
  • 400 Missing destination URL

Email

qrType: "email". 대시보드 가이드: Email QR 코드.
Request body
오류:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". 대시보드 가이드: SMS QR 코드.
Request body
오류:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". 대시보드 가이드: WiFi QR 코드.
Request body
오류:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
인쇄된 WiFi QR 코드의 유형은 바꾸지 마세요. 인쇄된 코드에는 이전 네트워크가 남아 있습니다.

PDF와 Image와 Video

qrType: "pdf", "image" 또는 "video". 대시보드 가이드: PDF, Image, Video. QR 코드 하나에는 파일 하나만 사용할 수 있습니다. PDF 번들과 이미지 갤러리는 API에서 사용할 수 없습니다. API에서 지원하지 않는 기능을 참조하세요.
파일을 업로드하고 fileId를 받는 방법은 파일을 참조하세요.

vCard

qrType: "vcard". 대시보드 가이드: vCard QR 코드. 랜딩 페이지와 빌더는 아래 줄 형식만 읽습니다. TEL;CELL:이나 EMAIL;TYPE=INTERNET: 같은 다른 형식은 저장되지만 페이지에는 표시되지 않습니다.
  • N:<last>;<first>;;;: 성과 이름입니다. 빌더: 둘 다 필수, 최대 40자.
  • FN:<first> <last>: 페이지에서는 읽지 않습니다. 대시보드 목록의 레이블로 쓰입니다.
  • ORG:<company>와 TITLE:<role>: 회사와 직책입니다. 빌더: 최대 40자.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: 전화, 휴대폰, 직장, 팩스 번호입니다(+와 숫자).
  • EMAIL:<email>: 이메일 주소입니다.
  • URL:<url>: 웹사이트입니다.
  • NOTE:<text>: 소개 글입니다. \\, \n, \;, \,로 이스케이프하세요. 빌더: 최대 200자.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: 주소입니다.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> 또는 URL;TYPE=<PLATFORM>:<url>: 소셜 링크입니다. 플랫폼마다 한 줄씩 씁니다.
  • PHOTO;VALUE=URI:<url>: 프로필 이미지 URL입니다. 어떤 파일 ID보다도 우선합니다.
  • X-GETQR-IMAGE-FILEID:<fileId>: 프로필 이미지(logo 용도)입니다.
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: 페이지 로고(logo 용도)입니다.
  • X-GETQR-LANDING-THEME:p|<0-4> 또는 X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: 랜딩 페이지 테마입니다. 프리셋 인덱스(0~4) 또는 배경, 버튼, 아이콘의 사용자 지정 색상입니다.
소셜 플랫폼: 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". 대시보드 가이드: Social Media QR 코드. data의 필드:
Request body
오류:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". 대시보드 가이드: Multi-Link QR 코드. data의 필드는 Social Media와 같지만, firstName, lastName, summary 대신 다음 필드를 사용합니다. customItems에서 logoFileId는 선택 사항이며, 없으면 대체 아이콘이 표시됩니다. 빌더: 소셜 링크 또는 비어 있지 않은 사용자 지정 항목이 하나 이상 필요합니다.
Request body
오류:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". 대시보드 가이드: Event QR 코드. data의 필드:
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, travelTour
Request body
오류:
  • 422 Expected a JSON object describing the event page for qrType "event".

QR 코드에 사용하는 파일

파일로 파일을 등록하고 업로드한 다음 fileId를 전달하세요. 쓰임새에 맞는 용도를 지정하세요.
  • pdf, image, video. PDF, Image, Video QR 코드의 콘텐츠입니다.
  • logo. 프로필 이미지, 페이지 로고, 사용자 지정 링크 아이콘, 중앙 로고입니다.
어떤 QR 코드에도 연결되지 않은 파일은 유예 기간이 지나면 삭제됩니다. fileId 오류(생성 시와 fileId를 보낸 PATCH에서 반환): 페이로드 안의 파일 ID(fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID 줄)는 검증되지 않습니다. logo 용도로 업로드한 경우에만 표시됩니다. 이 파일들은 QR 코드에 연결되므로 정리 과정에서 삭제되지 않습니다.

유형 변경

QR 코드 업데이트로 qrType을 변경할 수 있습니다. 새 유형에 맞는 data를 보내세요. 저장된 페이로드는 이전 유형의 것이므로, data 없이 유형을 바꾸면 거부됩니다. 업데이트 후 목적지는 다음 순서로 결정됩니다.
  1. vcard, social, multilink, event: 항상 호스팅 페이지.
  2. 대시보드에서 만든 PDF 번들 또는 이미지 갤러리: 해당 랜딩 페이지.
  3. pdf, image, video: 파일 URL(새 fileId, 없으면 저장된 것).
  4. 보낸 경우 link.url.
  5. 변경된 data.
  6. 저장된 URL.
유형을 바꿀 때의 동작:
  • pdf, image, video에서 다른 유형으로. fileId와 번들 또는 갤러리가 지워집니다.
  • pdf, image, video로. fileId도 함께 보내세요. 보내지 않으면 저장된 값이 재사용되며, 이것이 vCard 사진일 수도 있습니다.
  • app에서 다른 유형으로. 앱 이름, link.ios, link.android가 지워지므로 휴대폰도 새 목적지로 이동합니다.
  • wifi로. 이미지가 원본 페이로드로 바뀝니다. 이미 인쇄된 코드에는 단축 링크가 남아 있으며, 이제 wifi: URL로 리디렉션됩니다.
  • wifi에서 다른 유형으로. 인쇄된 코드에는 이전 네트워크가 남아 있습니다.
  • vcard, social, multilink, event로. 단축 링크가 새 호스팅 페이지를 가리킵니다.
  • vcard, social, multilink, event에서 다른 유형으로. 새 data를 보내세요. 목적지가 이를 따릅니다.
대시보드에서 만든 정적 QR 코드에는 단축 링크가 없으므로 link.url을 변경하면 422를 반환합니다.

API에서 지원하지 않는 기능

다음 대시보드 기능은 v1 API에 포함되지 않습니다. 알 수 없는 필드는 오류 없이 무시되므로 보내도 아무런 효과가 없습니다. 대시보드에서 만든 번들과 갤러리도 API로 조회, 일시 중지, 삭제할 수 있지만, 그 파일을 API로 변경할 수는 없습니다.

자주 발생하는 문제

link.url이 단축 링크가 리디렉션할 수 없는 스킴(geo:, smsto:, matmsg:, tel: 등)을 사용합니다. 이 페이지의 형식을 사용하세요.
data가 비어 있고 link.url도 없습니다. app의 경우 link.ios, link.android, link.url, data 중 하나 이상을 설정하세요.
링크 유형에서는 저장되는 data가 단축 링크입니다. 목적지는 url에서 읽으세요.
페이지는 해당 유형에 나열된 필드와 줄 형식만 읽습니다. 그 밖의 필드는 저장되지만 표시되지 않습니다.

다음 단계

QR 코드

파일

맞춤 설정

접근 규칙