รหัส QR
สร้างรหัส QR พร้อมโลโก้ สี สไตล์ และประเภทเนื้อหา แล้วแสดงรายการหรืออัปเดต
ประเภทที่รองรับ
ส่ง type เป็นหนึ่งในคีย์เหล่านี้ ฟิลด์เนื้อหาเปลี่ยนตามประเภท
- text
- url
- phone
- sms
- 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 จะสร้าง QR หนึ่งรหัสต่อบรรทัดใน text |
| 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 |
| string | ไม่ | — | ผู้รับเมื่อ type เป็น email | |
| email_subject | string | ไม่ | — | หัวข้ออีเมล |
| email_body | string | ไม่ | — | เนื้อหาอีเมล |
| 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
}'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
| ชื่อ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| 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 จะสร้าง QR หนึ่งรหัสต่อบรรทัดใน text |
| 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 ด้วยคีย์ของคุณ