QR 코드

로고, 색상, 스타일, 콘텐츠 유형으로 QR 코드를 만든 뒤 나열하거나 업데이트합니다.

지원 유형

type을 다음 키 중 하나로 전달하세요. 콘텐츠 필드는 유형에 따라 달라집니다.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

QR 코드 생성

요청 본문에 JSON을 보내세요. name과 type은 필수입니다. url 유형에는 url을 전달하세요. 스튜디오에서 디자인한 코드와 맞추려면 style, 색상, qr_code_logo를 추가하세요. file 유형은 API에서 사용할 수 없습니다.

이름	유형	필수	기본값	설명
name	string	예	—	리소스에 저장되는 레이블.
type	string	예	url	콘텐츠 유형. 지원되는 QR 키 중 하나(file 제외).
url	string	아니오	—	목적지 URL. type이 url일 때 필수.
text	string	아니오	—	일반 텍스트. type이 text일 때 필수. 대량 텍스트는 이 필드에서 줄을 나눕니다.
url_dynamic	boolean	아니오	false	true이면 짧은 링크가 만들어지고 QR이 그 링크를 인코딩하므로 나중에 목적지를 바꿀 수 있습니다.
project_id	integer	아니오	—	리소스를 연결할 프로젝트.
is_bulk	boolean	아니오	false	true이고 type이 text이면 text의 각 줄마다 QR 하나가 만들어집니다.
style	string	아니오	square	모듈 모양. 예: square, dot, rounded, heart, hexagon.
inner_eye_style	string	아니오	square	안쪽 파인더 패턴 모양. 예: square, dot, circle, rounded.
outer_eye_style	string	아니오	square	바깥쪽 파인더 패턴 모양. 예: square, circle, rounded, flower.
size	integer	아니오	500	픽셀 단위 이미지 크기, 50–2000.
margin	integer	아니오	0	콰이어트 존 모듈, 0–25.
ecc	string	아니오	M	오류 정정: L, M, Q 또는 H. 로고를 넣을 때는 H를 사용하세요.
foreground_type	string	아니오	color	color 또는 gradient.
foreground_color	string	아니오	#000000	모듈 색상(HEX).
foreground_gradient_style	string	아니오	horizontal	vertical, horizontal, diagonal, inverse_diagonal 또는 radial.
foreground_gradient_one	string	아니오	—	첫 번째 그라데이션 HEX 색상.
foreground_gradient_two	string	아니오	—	두 번째 그라데이션 HEX 색상.
background_color	string	아니오	#ffffff	배경 HEX 색상. 모듈보다 밝게 유지하세요.
background_color_transparency	integer	아니오	0	배경 투명도, 0–100.
custom_eyes_color	boolean	아니오	false	true이면 아이가 eyes_inner_color와 eyes_outer_color를 사용합니다.
eyes_inner_color	string	아니오	#000000	안쪽 아이 HEX 색상.
eyes_outer_color	string	아니오	#000000	바깥쪽 아이 HEX 색상.
qr_code_logo	string	아니오	—	로고 이미지 URL 또는 업로드된 파일 키.
qr_code_logo_size	number	아니오	25	QR 대비 로고 크기(퍼센트), 5–40.
frame	string	아니오	—	스튜디오의 선택 프레임 키.
frame_text	string	아니오	—	프레임에 그려지는 캡션.

유형별 콘텐츠 필드

이름	유형	필수	기본값	설명
phone	string	아니오	—	type이 phone일 때의 전화번호.
sms	string	아니오	—	type이 sms일 때의 전화번호.
sms_body	string	아니오	—	SMS 메시지 본문.
email	string	아니오	—	type이 email일 때의 수신자.
email_subject	string	아니오	—	이메일 제목.
email_body	string	아니오	—	이메일 본문.
whatsapp	string	아니오	—	WhatsApp 번호, 숫자만.
whatsapp_body	string	아니오	—	미리 채워진 WhatsApp 텍스트.
wifi_ssid	string	아니오	—	type이 wifi일 때의 네트워크 이름.
wifi_password	string	아니오	—	Wi-Fi 비밀번호.
wifi_encryption	string	아니오	WPA	nopass, WEP, WPA 또는 WPA/WPA2.
location_latitude	number	아니오	—	type이 location일 때의 위도.
location_longitude	number	아니오	—	type이 location일 때의 경도.
event	string	아니오	—	type이 event일 때의 이벤트 제목.
event_start_datetime	string	아니오	—	이벤트 시작 ISO 날짜·시간.
vcard first_name / last_name / email	string	아니오	—	vCard 필드: first_name, last_name, email 및 기타 스튜디오 키.

요청 예

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

더 많은 예

그라데이션 QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

Wi-Fi QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

응답 예제

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

QR 코드 목록

이름	유형	필수	설명
page	integer	아니오	Page number (default 1)
results_per_page	integer	아니오	Items per page (default 25, max 100)
search	string	아니오	Search term
search_by	string	아니오	Column to search
order_by	string	아니오	Sort column
order_type	string	아니오	asc or desc
datetime_start	string	아니오	ISO datetime filter start
datetime_end	string	아니오	ISO datetime filter end
project_id	integer	아니오	—
type	string	아니오	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

QR 코드 하나 읽기

이름	유형	필수	설명
id	integer	예	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

QR 코드 업데이트

이름	유형	필수	기본값	설명
id	integer	예	—	—
name	string	아니오	—	리소스에 저장되는 레이블.
type	string	아니오	url	콘텐츠 유형. 지원되는 QR 키 중 하나(file 제외).
url	string	아니오	—	목적지 URL. type이 url일 때 필수.
text	string	아니오	—	일반 텍스트. type이 text일 때 필수. 대량 텍스트는 이 필드에서 줄을 나눕니다.
url_dynamic	boolean	아니오	false	true이면 짧은 링크가 만들어지고 QR이 그 링크를 인코딩하므로 나중에 목적지를 바꿀 수 있습니다.
project_id	integer	아니오	—	리소스를 연결할 프로젝트.
is_bulk	boolean	아니오	false	true이고 type이 text이면 text의 각 줄마다 QR 하나가 만들어집니다.
style	string	아니오	square	모듈 모양. 예: square, dot, rounded, heart, hexagon.
inner_eye_style	string	아니오	square	안쪽 파인더 패턴 모양. 예: square, dot, circle, rounded.
outer_eye_style	string	아니오	square	바깥쪽 파인더 패턴 모양. 예: square, circle, rounded, flower.
size	integer	아니오	500	픽셀 단위 이미지 크기, 50–2000.
margin	integer	아니오	0	콰이어트 존 모듈, 0–25.
ecc	string	아니오	M	오류 정정: L, M, Q 또는 H. 로고를 넣을 때는 H를 사용하세요.
foreground_type	string	아니오	color	color 또는 gradient.
foreground_color	string	아니오	#000000	모듈 색상(HEX).
foreground_gradient_style	string	아니오	horizontal	vertical, horizontal, diagonal, inverse_diagonal 또는 radial.
foreground_gradient_one	string	아니오	—	첫 번째 그라데이션 HEX 색상.
foreground_gradient_two	string	아니오	—	두 번째 그라데이션 HEX 색상.
background_color	string	아니오	#ffffff	배경 HEX 색상. 모듈보다 밝게 유지하세요.
background_color_transparency	integer	아니오	0	배경 투명도, 0–100.
custom_eyes_color	boolean	아니오	false	true이면 아이가 eyes_inner_color와 eyes_outer_color를 사용합니다.
eyes_inner_color	string	아니오	#000000	안쪽 아이 HEX 색상.
eyes_outer_color	string	아니오	#000000	바깥쪽 아이 HEX 색상.
qr_code_logo	string	아니오	—	로고 이미지 URL 또는 업로드된 파일 키.
qr_code_logo_size	number	아니오	25	QR 대비 로고 크기(퍼센트), 5–40.
frame	string	아니오	—	스튜디오의 선택 프레임 키.
frame_text	string	아니오	—	프레임에 그려지는 캡션.

요청 예

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

QR 코드 삭제

이름	유형	필수	설명
id	integer	예	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

매개변수 이름과 JSON 예제는 영어로 표시됩니다. YOUR_API_KEY를 계정 키로 바꾸세요.