รหัส 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

ชื่อประเภทจำเป็นค่าเริ่มต้นคำอธิบาย
namestringใช่ป้ายชื่อที่บันทึกบนทรัพยากร
typestringใช่urlประเภทเนื้อหา คีย์ QR ที่รองรับอย่างใดอย่างหนึ่ง ยกเว้น file
urlstringไม่URL ปลายทาง จำเป็นเมื่อ type เป็น url
textstringไม่ข้อความธรรมดา จำเป็นเมื่อ type เป็น text สำหรับข้อความจำนวนมาก ให้แยกบรรทัดในฟิลด์นี้
url_dynamicbooleanไม่falseถ้าเป็น true จะสร้างลิงก์สั้น และ QR เข้ารหัสลิงก์นั้น เพื่อให้เปลี่ยนปลายทางได้ภายหลัง
project_idintegerไม่โปรเจกต์ที่จะแนบทรัพยากร
is_bulkbooleanไม่falseถ้าเป็น true และ type เป็น text จะสร้าง QR หนึ่งรหัสต่อบรรทัดใน text
stylestringไม่squareรูปทรงโมดูล ตัวอย่าง: square, dot, rounded, heart, hexagon
inner_eye_stylestringไม่squareรูปทรงแพทเทิร์นค้นหาด้านใน ตัวอย่าง: square, dot, circle, rounded
outer_eye_stylestringไม่squareรูปทรงแพทเทิร์นค้นหาด้านนอก ตัวอย่าง: square, circle, rounded, flower
sizeintegerไม่500ขนาดภาพเป็นพิกเซล 50–2000
marginintegerไม่0โมดูลโซนเงียบ 0–25
eccstringไม่Mการแก้ไขข้อผิดพลาด: L, M, Q หรือ H ใช้ H เมื่อใส่โลโก้
foreground_typestringไม่colorcolor หรือ gradient
foreground_colorstringไม่#000000สีโมดูลเป็น HEX
foreground_gradient_stylestringไม่horizontalvertical, horizontal, diagonal, inverse_diagonal หรือ radial
foreground_gradient_onestringไม่สี HEX ไล่สีแรก
foreground_gradient_twostringไม่สี HEX ไล่สีที่สอง
background_colorstringไม่#ffffffสีพื้นหลัง HEX ให้สว่างกว่าโมดูล
background_color_transparencyintegerไม่0ความโปร่งใสของพื้นหลัง 0–100
custom_eyes_colorbooleanไม่falseถ้าเป็น true ตาจะใช้ eyes_inner_color และ eyes_outer_color
eyes_inner_colorstringไม่#000000สี HEX ของตาด้านใน
eyes_outer_colorstringไม่#000000สี HEX ของตาด้านนอก
qr_code_logostringไม่URL รูปโลโก้ หรือคีย์ไฟล์ที่อัปโหลด
qr_code_logo_sizenumberไม่25ขนาดโลโก้เป็นเปอร์เซ็นต์ของ QR 5–40
framestringไม่คีย์กรอบเสริมจากสตูดิโอ
frame_textstringไม่คำบรรยายที่วาดบนกรอบ

ฟิลด์เนื้อหาตามประเภท

ชื่อประเภทจำเป็นค่าเริ่มต้นคำอธิบาย
phonestringไม่หมายเลขโทรศัพท์เมื่อ type เป็น phone
smsstringไม่หมายเลขโทรศัพท์เมื่อ type เป็น sms
sms_bodystringไม่เนื้อหาข้อความ SMS
emailstringไม่ผู้รับเมื่อ type เป็น email
email_subjectstringไม่หัวข้ออีเมล
email_bodystringไม่เนื้อหาอีเมล
whatsappstringไม่หมายเลข WhatsApp ตัวเลขเท่านั้น
whatsapp_bodystringไม่ข้อความ WhatsApp ที่กรอกไว้ล่วงหน้า
wifi_ssidstringไม่ชื่อเครือข่ายเมื่อ type เป็น wifi
wifi_passwordstringไม่รหัสผ่าน Wi-Fi
wifi_encryptionstringไม่WPAnopass, WEP, WPA หรือ WPA/WPA2
location_latitudenumberไม่ละติจูดเมื่อ type เป็น location
location_longitudenumberไม่ลองจิจูดเมื่อ type เป็น location
eventstringไม่ชื่อกิจกรรมเมื่อ type เป็น event
event_start_datetimestringไม่วันที่-เวลา ISO ของการเริ่มกิจกรรม
vcard first_name / last_name / emailstringไม่ฟิลด์ 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
}'

QR Wi-Fi

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
ชื่อประเภทจำเป็นคำอธิบาย
pageintegerไม่Page number (default 1)
results_per_pageintegerไม่Items per page (default 25, max 100)
searchstringไม่Search term
search_bystringไม่Column to search
order_bystringไม่Sort column
order_typestringไม่asc or desc
datetime_startstringไม่ISO datetime filter start
datetime_endstringไม่ISO datetime filter end
project_idintegerไม่
typestringไม่
curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'
GET/api/v1/qr-codes/{id}
อ่าน รหัส QR หนึ่งรายการ
ชื่อประเภทจำเป็นคำอธิบาย
idintegerใช่
curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/v1/qr-codes/{id}
อัปเดต รหัส QR
ชื่อประเภทจำเป็นค่าเริ่มต้นคำอธิบาย
idintegerใช่
namestringไม่ป้ายชื่อที่บันทึกบนทรัพยากร
typestringไม่urlประเภทเนื้อหา คีย์ QR ที่รองรับอย่างใดอย่างหนึ่ง ยกเว้น file
urlstringไม่URL ปลายทาง จำเป็นเมื่อ type เป็น url
textstringไม่ข้อความธรรมดา จำเป็นเมื่อ type เป็น text สำหรับข้อความจำนวนมาก ให้แยกบรรทัดในฟิลด์นี้
url_dynamicbooleanไม่falseถ้าเป็น true จะสร้างลิงก์สั้น และ QR เข้ารหัสลิงก์นั้น เพื่อให้เปลี่ยนปลายทางได้ภายหลัง
project_idintegerไม่โปรเจกต์ที่จะแนบทรัพยากร
is_bulkbooleanไม่falseถ้าเป็น true และ type เป็น text จะสร้าง QR หนึ่งรหัสต่อบรรทัดใน text
stylestringไม่squareรูปทรงโมดูล ตัวอย่าง: square, dot, rounded, heart, hexagon
inner_eye_stylestringไม่squareรูปทรงแพทเทิร์นค้นหาด้านใน ตัวอย่าง: square, dot, circle, rounded
outer_eye_stylestringไม่squareรูปทรงแพทเทิร์นค้นหาด้านนอก ตัวอย่าง: square, circle, rounded, flower
sizeintegerไม่500ขนาดภาพเป็นพิกเซล 50–2000
marginintegerไม่0โมดูลโซนเงียบ 0–25
eccstringไม่Mการแก้ไขข้อผิดพลาด: L, M, Q หรือ H ใช้ H เมื่อใส่โลโก้
foreground_typestringไม่colorcolor หรือ gradient
foreground_colorstringไม่#000000สีโมดูลเป็น HEX
foreground_gradient_stylestringไม่horizontalvertical, horizontal, diagonal, inverse_diagonal หรือ radial
foreground_gradient_onestringไม่สี HEX ไล่สีแรก
foreground_gradient_twostringไม่สี HEX ไล่สีที่สอง
background_colorstringไม่#ffffffสีพื้นหลัง HEX ให้สว่างกว่าโมดูล
background_color_transparencyintegerไม่0ความโปร่งใสของพื้นหลัง 0–100
custom_eyes_colorbooleanไม่falseถ้าเป็น true ตาจะใช้ eyes_inner_color และ eyes_outer_color
eyes_inner_colorstringไม่#000000สี HEX ของตาด้านใน
eyes_outer_colorstringไม่#000000สี HEX ของตาด้านนอก
qr_code_logostringไม่URL รูปโลโก้ หรือคีย์ไฟล์ที่อัปโหลด
qr_code_logo_sizenumberไม่25ขนาดโลโก้เป็นเปอร์เซ็นต์ของ QR 5–40
framestringไม่คีย์กรอบเสริมจากสตูดิโอ
frame_textstringไม่คำบรรยายที่วาดบนกรอบ

ตัวอย่างคำขอ

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
ชื่อประเภทจำเป็นคำอธิบาย
idintegerใช่
curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

ชื่อพารามิเตอร์และตัวอย่าง JSON แสดงเป็นภาษาอังกฤษ แทนที่ YOUR_API_KEY ด้วยคีย์ของคุณ