คู่มือ API QR Code สำหรับนักพัฒนา

API QR Code ช่วยให้ผู้ใช้สามารถสร้าง QR Code คุณภาพสูงโดยโปรแกรม หรือรวมการสร้าง QR Code จำนวนมากอย่างรวดเร็ว API นี้ให้วิธีที่ง่ายและมีประสิทธิภาพในการสร้าง QR Code สำหรับกรณีการใช้งานต่างๆ เช่น การชำระเงินอัตโนมัติ การรวมเข้ากับแอปพลิเคชัน การสร้างป้ายผลิตภัณฑ์ และอื่นๆ API นี้รองรับตัวเลือกการปรับแต่งต่างๆ เช่น ขนาด สี รูปร่าง ขอบ ประเภท ฯลฯ นักพัฒนาสามารถรวมเข้ากับแอปพลิเคชันของพวกเขาโดยการทำคำขอ HTTP และให้ API key สำหรับการยืนยันตัวตน หรือใช้ไลบรารีของเรา

API Key

API key สำหรับบัญชีของคุณสามารถสร้างได้ที่ หน้าบัญชี API key สามารถรวมในคำขอได้ทั้งในรูปแบบพารามิเตอร์ URL เช่น: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY หรือในหัวข้อ `GenQRCode-apikey` สำหรับคู่มือนี้เราจะสมมติว่าใช้วิธีการผ่าน header ซึ่งเป็นตัวเลือกที่ปลอดภัยกว่า แต่ทั้งสองวิธีสามารถใช้แทนกันได้ API key ควรถือเป็นความลับและคุณไม่ควรแชร์กับใคร

การจำกัดอัตราการใช้งาน

การจำกัดอัตราการใช้งานมีไว้เพื่อให้การใช้งาน API เป็นไปอย่างยุติธรรม Free tier รวม 180 โทเค็นต่อชั่วโมง QR Code ปกติใช้ 1 โทเค็นต่อหนึ่งอัน โดยมีขีดจำกัดสูงสุด 180 โทเค็นต่อชั่วโมง เท่ากับ 1 QR Code ทุก 20 วินาที นอกจากนี้ endpoint การเรียกแบบเร็วจะใช้ 1/50 โทเค็น เท่ากับ 2.5 QR Code ต่อวินาที การใช้ endpoint เร็วเหล่านี้แนะนำเมื่อไม่ต้องการปรับแต่ง QR Code หากเกินขีดจำกัดโทเค็น จะมีการส่งสถานะโค้ด 429 กลับ ซึ่งหมายความว่าการขอได้ถูกจำกัดอัตราการใช้งาน

การใช้หลายบัญชีเพื่อหลีกเลี่ยงข้อจำกัดนี้เป็นสิ่งต้องห้าม หากต้องการขีดจำกัดที่สูงกว่า กรุณาติดต่อเราเพื่อสอบถามราคา

ไลบรารี

Java Library

Static QR Code API

ประเภท QR Code

ประเภทของ QR Code เป็นฐานของ QR Code ทุกชนิด มันกำหนดวิธีการเข้ารหัสข้อมูลและวิธีการที่ QR Code ทำงานเมื่อถูกสแกน การเลือกประเภทที่ถูกต้องเป็นสิ่งสำคัญ เนื่องจากจะส่งผลต่อการทำงานของ QR Code ของคุณ ด้านล่างนี้คุณจะพบประเภทที่มีให้เลือกทั้งหมด

Text

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 0 For a Text QR Code
text String false ข้อความภายใน QR Code

WiFi

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 1 For a WiFi QR Code
network String false ชื่อเครือข่าย Wi-Fi
password String true รหัสผ่าน Wi-Fi
hidden String true เครือข่าย Wi-Fi ซ่อนอยู่หรือไม่
encryption String true การเข้ารหัสที่ใช้ในเครือข่าย Wi-Fi

ค่าที่เป็นไปได้

wep ใช้ตัวนี้หากเครือข่าย Wi-Fi ยังคงใช้การเข้ารหัส WEP แบบเก่า
nopass ใช้ตัวนี้หากเครือข่าย Wi-Fi ไม่มีรหัสผ่าน
wpa ค่าดีฟอลต์ ใช้สำหรับการเข้ารหัส WPA หากไม่แน่ใจว่าจะใช้ตัวไหน ให้ใช้ตัวนี้

SMS

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 2 For a SMS QR Code
text String false ข้อความข้อความ
number String false หมายเลขโทรศัพท์

Email

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 3 For a Email QR Code
email String true ที่อยู่อีเมลในฟิลด์ "ถึง"
subject String true หัวข้อของอีเมล
message String true ข้อความของอีเมล

Phone

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 4 For a Phone QR Code
number String false หมายเลขโทรศัพท์

Crypto

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 5 For a Crypto QR Code
cryptotype String false ประเภทของ Crypto ที่จะส่ง
address String false ที่อยู่ Crypto ของผู้รับ
amount String true จำนวน Crypto ที่จะส่ง

vCard

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 6 For a vCard QR Code
vc_first_name String false ชื่อของ vCard
vc_last_name String false นามสกุลของ vCard
vc_company String true บริษัท
vc_job String true ตำแหน่งงาน
vc_street String true ถนน
vc_city String true เมือง
vc_state String true รัฐ
vc_zip String true รหัสไปรษณีย์
vc_country String true ประเทศ
vc_phone String true หมายเลขโทรศัพท์
vc_mobile String true หมายเลขโทรศัพท์มือถือ
vc_fax String true หมายเลขแฟกซ์
vc_website String true เว็บไซต์ URL
vc_email String true ที่อยู่อีเมล

Whatsapp

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 7 For a Whatsapp QR Code
number String false หมายเลขโทรศัพท์
text String true ข้อความ WhatsApp

vEvent

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 8 For a vEvent QR Code
ve_summary String true สรุปของ vEvent
ve_description String true คำอธิบายของ vEvent
ve_location String true สถานที่ของ vEvent
ve_timezone String true โซนเวลาของเวลาเริ่มต้นและเวลาสิ้นสุดของ vEvent ตัวอย่างใช้ "Europe/Amsterdam" สำหรับโซนเวลาของอัมสเตอร์ดัม
ve_url String true URL ของ vEvent
ve_start String true เวลาเริ่มต้นของ vEvent ตัวอย่างใช้ "20250101T083000" สำหรับวันที่ 1 มกราคม 2025 เวลา 8:30
ve_end String true เวลาสิ้นสุดของ vEvent ตัวอย่างใช้ "20250101T093000" สำหรับวันที่ 1 มกราคม 2025 เวลา 9:30

Geo

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
type Int false Use 9 For a Geo QR Code
ge_latitude String false ละติจูดที่ต้องการเข้ารหัส
ge_longitude String false ลองจิจูดที่ต้องการเข้ารหัส

ตัวอย่าง QR Code ข้อความ

URL https://api.genqrcode.com/public/generate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "type": 0,
  "text": "https://genqrcode.com"
}
การตอบกลับ Text QR Code example

ตัวอย่าง QR Code Wi-Fi

URL https://api.genqrcode.com/public/generate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "type": 1,
  "network": "GenQRCode",
  "password": false,
  "hidden": false,
  "encryption": "wpa"
}
การตอบกลับ WiFi QR Code example

พารามิเตอร์ทั่วไป

นี่คือพารามิเตอร์ทั่วไปทั้งหมดที่สามารถปรับแต่งได้พร้อมคำอธิบายวิธีการใช้งาน

พารามิเตอร์ ประเภท ค่าปริยาย คำอธิบาย
imageformat String png รูปแบบของภาพ QR Code

ค่าที่เป็นไปได้

tiff รูปแบบภาพ TIFF
svg รูปแบบภาพ SVG
gif รูปแบบภาพ GIF
obj รูปแบบภาพ OBJ รองรับสีเต็มรูปแบบ
png รูปแบบภาพ PNG
jpeg รูปแบบภาพ JPEG ไม่รองรับความโปร่งใส
eps รูปแบบภาพ EPS
stl รูปแบบภาพ STL ไม่มีการรองรับสี
webp รูปแบบภาพ WEBP
3mf รูปแบบภาพ 3MF
bordersize Int 4 ขนาดขอบรอบ QR Code
width Int 500 ความกว้างของ QR Code ขนาดสูงสุด 2000
height Int 500 ความสูงของ QR Code ขนาดสูงสุด 2000

พารามิเตอร์สี

นี่คือพารามิเตอร์สีทั้งหมดที่สามารถปรับแต่งได้พร้อมคำอธิบายวิธีการใช้งาน

พารามิเตอร์ ประเภท ค่าปริยาย คำอธิบาย
color String #000000 สีของ QR Code รูปแบบต้องเป็น #RRGGBB หรือ #RRGGBBAA ค่าของ RGBA เป็นเลขฐานสิบหก ตั้งแต่ 00 ถึง FF
custom_color_pattern String 1 รูปแบบของสีที่ใช้ ตัวอย่างเช่น หากสีเป็น #ff0000, #00ff00, และ #0000ff และรูปแบบเป็น 1,2,3,3,2,1 สีจะสลับตามรูปแบบนั้น ตัวอย่างจะมีให้ในคู่มือภายหลัง
background_color String #FFFFFF สีพื้นหลังของ QR Code หากต้องการทำให้พื้นหลังโปร่งใส ให้ตั้งค่า alpha channel เป็น 00 เช่น #00000000
inner_eye_color String #000000 สีของตาข่ายด้านในของ QR Code
outer_eye_color String #000000 สีของตาข่ายด้านนอกของ QR Code
frame_color String #000000 สีของกรอบรอบ QR Code ต้องเปิดใช้งานกรอบเพื่อให้มีผล

ตัวอย่าง QR Code สี

URL https://api.genqrcode.com/public/generate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "type": 0,
  "text": "https://genqrcode.com",
  "color": "#ff0000",
  "background_color": "#aaffaa",
  "inner_eye_color": "#ffaaaa",
  "outer_eye_color": "#ffaaff"
}
การตอบกลับ Color QR Code example

ตัวอย่าง QR Code ลวดลายสี

URL https://api.genqrcode.com/public/generate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "type": 0,
  "text": "https://genqrcode.com",
  "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d",
  "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6"
}
การตอบกลับ Color pattern QR Code example

พารามิเตอร์กรอบ รูปร่าง และโลโก้

นี่คือพารามิเตอร์กรอบ รูปร่าง และโลโก้ทั้งหมดที่สามารถปรับแต่งได้พร้อมคำอธิบายวิธีการใช้งาน

พารามิเตอร์ ประเภท ค่าปริยาย คำอธิบาย
style Int 0 รูปแบบของสี่เหลี่ยมใน QR Code
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
inner_eye_style Int 0 รูปแบบของตาข่ายด้านในของ QR Code
0
1
2
3
4
5
6
7
outer_eye_style Int 0 รูปแบบของตาข่ายด้านนอกของ QR Code
0
1
2
3
4
5
6
frame_style Int 0 รูปแบบของกรอบรอบ QR Code
0
1
/> /> /> /> /> />SCAN ME
2
/> /> /> /> /> /> /> />SCAN ME
3
/> /> /> />SCAN ME
4
/> /> />SCAN ME
5
/>SCAN ME
6
/>SCAN ME
7
/> /> />
8
/> /> /> /> />
9
/> /> /> /> /> /> /> /> /> /> /> /> />
10
/> /> /> /> /> /> />SCAN ME
11
/> />SCAN ME
12
SCAN ME
13
SCAN ME
frame_text String SCAN ME ข้อความภายในกรอบ กรอบที่มีข้อความต้องถูกตั้งค่าก่อนที่จะสามารถแสดงข้อความได้
logo String โลโก้ที่จะใช้ภายใน QR Code
youtube
wifi
google-maps
facebook
spotify
threads
zoom
instagram
linkedin
genqrcode
google-drive
airbnb
skype
snapchat
twitter
x-twitter
reddit
logo_remove_background Boolean false ควรลบพื้นหลังหลังโลโก้หรือไม่

ตัวอย่าง QR Code โลโก้และรูปทรง

URL https://api.genqrcode.com/public/generate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "type": 0,
  "text": "https://x.com/genqrcode",
  "style": 22,
  "inner_eye_style": 1,
  "outer_eye_style": 4,
  "frame": 10,
  "frame_text": "My X Page",
  "logo": "x-twitter",
  "logo_remove_background":true
}
การตอบกลับ Style and logo QR Code example

ตัวอย่างโลโก้แบบกำหนดเอง

เพื่อใช้โลโก้แบบกำหนดเอง เราต้องอัปโหลดโลโก้ของเราผ่านคำขอ multipart form data ผลลัพธ์สามารถใช้ในฟิลด์โลโก้ได้

URL https://api.genqrcode.com/public/upload/logo
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
Content-Type: multipart/form-data
การตอบกลับ 586d0136af8a06e4a2b50cf9f2af0b72

Fast QR Code API

Fast QR Code API ใช้เพียง 1/50 โทเค็นจาก API ปกติ QR Code ถูกปรับให้เหมาะสมกับความเร็วและขนาดการดาวน์โหลด ขณะนี้รองรับทุกประเภท QR Code แต่รองรับพารามิเตอร์การปรับแต่งเพียงไม่กี่ตัว

พารามิเตอร์ Fast QR Code

นี่คือพารามิเตอร์ทั้งหมดของ Fast QR Code พร้อมคำอธิบายวิธีการใช้งาน

พารามิเตอร์ ประเภท ค่าปริยาย คำอธิบาย
imageformat String png รูปแบบของภาพ QR Code

ค่าที่เป็นไปได้

svg รูปแบบภาพ SVG
png รูปแบบภาพ PNG
bordersize Int 4 ขนาดขอบรอบ QR Code
width Int 500 ความกว้างของ QR Code จะปรับขนาดโดยอัตโนมัติเพื่อหลีกเลี่ยงปัญหาจากการปรับขนาด ขนาดสูงสุด 4000
height Int 500 ความสูงของ QR Code จะปรับขนาดโดยอัตโนมัติเพื่อหลีกเลี่ยงปัญหาจากการปรับขนาด ขนาดสูงสุด 4000

ตัวอย่าง QR Code ข้อความเร็ว

URL https://api.genqrcode.com/public/fastgenerate
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "imageformat": "png",
  "type": 0,
  "text": "https://genqrcode.com"
}
การตอบกลับ Text QR Code example

Fast Batch QR Code API

ตัวอย่าง QR Code ข้อความแบบแบทช์เร็ว

URL https://api.genqrcode.com/public/fastbatch
วิธีการขอ POST
หัวข้อ GenQRCode-apikey: API_KEY
เนื้อหา 
{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}
การตอบกลับ QR Codes in a zip file.