เอกสาร QRTIGER APIs
API QR Code ที่กำหนดเองของเรานำเสนอโซลูชันระดับมืออาชีพสำหรับแบรนด์ที่จำเป็นต้องมีเทมเพลต QR Code ที่กำหนดเองพร้อมระบบติดตามข้อมูล, QR Code แบบไดนามิกหรือ QR Code เป็นกลุ่ม และมี QR Code รวมอยู่ใน CRM
API ของเราและสามารถใช้ได้บน 'Mashape' สำหรับคำถามอื่นๆคุณสามารถ 'ติดต่อเรา' API ของเราสามารถใช้ได้ทั่วโลก หากคุณต้องการ QR Code ของคุณให้สามารถใช้งานได้ในประเทศจีนโปรดติดต่อเรา นอกจากนี้เรายังสามารถทำ QR Code ที่กำหนดขึ้นเองสำหรับการชำระเงินผ่านมือถือ
qrId:
เอกสาร
ดูวิธีใช้งานผ่านวิดีโอ YouTube นี้
สร้าง QR Code
1.เข้าสู่ระบบครั้งแรกและรับ คีย์ API เพื่ออนุญาตใน ติดตามข้อมูล --> การตั้งค่าบัญชี --> คีย์ API
เข้าสู่ระบบครั้งแรกและรับ คีย์ API เพื่ออนุญาตใน ติดตามข้อมูล --> การตั้งค่าบัญชี --> คีย์ API
2.Add this API key in every req (GET/POST) as Authorization: Bearer คีย์ API
Add this API key in every req (GET/POST) as Authorization: Bearer คีย์ API
3. สร้าง QR Code ที่กำหนดเองแบบคงที่
| URL | /api/qr/static |
| วิธีการ | POST |
| การอนุญาต | Bearer API KEY |
| การตอบสนอง | Binary Image File (PNG, SVG) |
Request parameter
| qrCategory | string | url | qrCategory กำหนดประเภทที่แตกต่างกันของ qr เช่น url, Vcard, facebook ฯลฯ ตรวจสอบตาราง qrCategory ด้านล่าง |
| text | String | https://qrcode-tiger.com | การเปลี่ยนเส้นทาง URL ที่คุณต้องการจะถูกฝังใน QR |
| size | number | 500 | ขนาดของ QR |
| logo | url | null | เพิ่ม url โลโก้ เพื่อเปิดใช้งานโลโก้ที่จุดกึ่งกลางของ QR |
| colorDark | string | #5e0bf0 | สีของลวดลาย qr |
| backgroundColor | String | #ffffff | สีพื้นหลังของคิวอาร์ (หมายเหตุ: เลือกสีที่สว่างเสมอสำหรับ QR ที่สแกนได้ทั้งหมด) |
| gradient | Boolean | false | ตั้งค่า “true” เพื่อเปิดใช้งานการไล่ระดับสี |
| grdType | Number | 0 (Left-to-Right) | ตรวจสอบตารางด้านล่างสำหรับ grdType |
| color01 | String | #5e0bf0 | ไล่โทนสี 1 ของรูปแบบ qr |
| color02 | String | #f30505 | ไล่โทนสี 2 ของรูปแบบ qr |
| eye_color | Boolean | false | ตั้งค่า “true” เพื่อเปลี่ยนสีตา |
| eye_color01 | String | #5e0bf0 | สีของตาชั้นนอก |
| eye_color02 | String | #f30505 | สีของดวงตาด้านใน |
| eye_outer | String | eyeOuter0 | การออกแบบที่แตกต่างกันของตาชั้นนอก ตรวจสอบตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด |
| eye_inner | String | eyeInner0 | การออกแบบตาชั้นในแบบต่างๆ ให้ดูตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด |
| qrData | String | pattern0 | การออกแบบรูปแบบข้อมูล QR ที่แตกต่างกัน ตรวจสอบตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด |
| qrFormat | String | png | ดาวน์โหลดไฟล์ภาพไบนารีประเภท “png” หรือ “svg” |
| transparentBkg | Boolean | false | พื้นหลัง QR จะมีความโปร่งใสหากมีการเปิดใช้งาน |
| frame | Number | null | QR จะประกอบด้วยเฟรมหากเปิดใช้งาน สามารถตรวจสอบตารางด้านล่างสำหรับการออกแบบเฟรม |
| frameColor | String | null | สีของกรอบ เปลี่ยนสีของข้อความในกรอบ |
| frameText | String | SCAN ME | กรอบข้อความที่แสดงอยู่เหนือกรอบ QR |
ตัวอย่าง
| URL | /api/qr/static |
| วิธีการ | POST |
| พารามิเตอร์ | {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "scan_me.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://qrcode-tiger.com"
} |
| การตอบสนอง | {
"data": "base 64 QR image data",
"url": "1601477992984.png"
} |
4. รับรายการแคมเปญ QR ทั้งหมดของหมวดหมู่ QR ที่แตกต่างกัน
| URL | /api/campaign/ |
| วิธีการ | GET |
| การอนุญาต | Bearer API KEY |
| การตอบสนอง | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
พารามิเตอร์แบบสอบถาม
| พารามิเตอร์ | ค่าเริ่มต้น | คำอธิบาย |
|---|---|---|
| page | 1 | จำนวนหน้า |
| limit | 5 | จำนวนแคมเปญต่อหน้า |
| sort | 1 | เรียงตามวันที่(1) หรือ ชื่อ(2) |
| category | url | หมวดหมู่กำหนดประเภทที่แตกต่างกันของ qr เช่น url, Vcard, facebook ฯลฯ ตรวจสอบตาราง qrCategory ด้านล่าง |
ตัวอย่าง
| URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
| วิธีการ | GET |
| พารามิเตอร์ | {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "scan_me.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://qrcode-tiger.com"
} |
| การตอบสนอง | {
"query": {
"limit": 1,
"page": 1,
"total": 146
},
"data": [
{
"scans": 0,
"_id": "5f6f373a33320a0ca52581b0",
"qrId": "HNXP",
"qrType": "qr2",
"qrCategory": "url",
"shortUrl": "https://qrcode-tiger.com/HNXP",
"redirectUrl": "https://www.qrcode-tiger.com/",
"murlData": [],
"qrName": "Campaign HNXP",
"qrImage": "HNXP.png",
"createdAt": "2020-09-26T12:42:34.070Z",
"updatedAt": "2020-09-26T12:42:34.070Z",
"user": null,
"id": "5f6f373a33320a0ca52581b0"
}
]
} |
5. สร้าง QR Code Visual กำหนดเองแบบไดนามิก
| URL | /api/campaign/ |
| วิธีการ | POST |
| การอนุญาต | Bearer API KEY |
| การตอบสนอง | Binary Image File (PNG, SVG) |
พารามิเตอร์แบบสอบถาม
| พารามิเตอร์ | ประเภท | ค่าเริ่มต้น | คำอธิบาย | |
|---|---|---|---|---|
| qrUrl | String | https://qrcode-tiger.com | URL ของการเปลี่ยนเส้นทางที่คุณต้องการจะถูกฝังอยู่ใน QR | |
| qrType | String | qr2 | QRType กำหนดพฤติกรรมของ QR เช่น URL เปลี่ยนเส้นทางเดียวหรือ URL เปลี่ยนเส้นทางหลาย (“qr2” หรือ “murl”) | |
| qrCategory | String | url | qrCategory กำหนดประเภทที่แตกต่างกันของ qr เช่น url, Vcard, facebook ฯลฯ ตรวจสอบตาราง qrCategory ด้านล่าง | |
| qr: | JSON Object | ออกแบบ QR Code ของคุณ เช่น สี รูปแบบข้อมูล ดวงตา ฯลฯ ภายในสิ่งนี้ | ||
| size | Number | 500 | ขนาดของ QR | |
| logo | String (url) | null | เพิ่ม url โลโก้ เพื่อเปิดใช้งานโลโก้ที่จุดกึ่งกลางของ QR | |
| colorDark | String | #5e0bf0 | สีของลวดลาย qr | |
| backgroundColor | String | #ffffff | สีพื้นหลังของคิวอาร์ (หมายเหตุ: เลือกสีที่สว่างเสมอสำหรับ QR ที่สแกนได้ทั้งหมด) | |
| gradient | Boolean | false | ตั้งค่า “true” เพื่อเปิดใช้งานการไล่ระดับสี | |
| grdType | Number | 0 (Left-to-Right) | ตรวจสอบตารางด้านล่างสำหรับ grdType | |
| color01 | String | #5e0bf0 | ไล่โทนสี 1 ของรูปแบบ qr | |
| color02 | String | #f30505 | ไล่โทนสี 2 ของรูปแบบ qr | |
| eye_color | Boolean | false | ตั้งค่า “true” เพื่อเปลี่ยนสีตา | |
| eye_color01 | String | #5e0bf0 | สีของตาชั้นนอก | |
| eye_color02 | String | #f30505 | สีของดวงตาด้านใน | |
| eye_outer | String | eyeOuter0 | การออกแบบที่แตกต่างกันของตาชั้นนอก ตรวจสอบตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด | |
| eye_inner | String | eyeInner0 | การออกแบบตาชั้นในแบบต่างๆ ให้ดูตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด | |
| qrData | String | pattern0 | การออกแบบรูปแบบข้อมูล QR ที่แตกต่างกัน ตรวจสอบตารางด้านล่างสำหรับรูปแบบการออกแบบทั้งหมด | |
| qrFormat | String | png | ดาวน์โหลดไฟล์ภาพไบนารีประเภท “png” หรือ “svg” | |
| transparentBkg | Boolean | false | พื้นหลัง QR จะมีความโปร่งใสหากมีการเปิดใช้งาน | |
| frame | Number | null | QR จะประกอบด้วยเฟรมหากเปิดใช้งาน สามารถตรวจสอบตารางด้านล่างสำหรับการออกแบบเฟรม | |
| frameColor | String | null | สีของกรอบ เปลี่ยนสีของข้อความในกรอบ | |
| frameText | String | SCAN ME | กรอบข้อความที่แสดงอยู่เหนือกรอบ QR |
ตัวอย่าง
| URL | /api/campaign |
| วิธีการ | POST |
| Request Body | {
"qr": {
"size": 500,
"colorDark": "rgb(5,64,128)",
"logo": "1545827032075.png",
"eye_outer": "eyeOuter2",
"eye_inner": "eyeInner1",
"qrData": "pattern0",
"backgroundColor": "rgb(255,255,255)",
"transparentBkg": false,
"qrCategory": "url",
"text": "https://www.qrcode-tiger.com.com/"
},
"murlData": [],
"qrUrl": "https://www.qrcode-tiger.com.com",
"qrType": "qr2",
"qrCategory": "url",
"qrId": "MP72"
} |
| Request Body | |
grdType (Default 0)
| พารามิเตอร์ | ประเภท | ค่า | คำอธิบาย |
|---|---|---|---|
| ซ้ายขวา | String | linear | ไล่ระดับจากซ้ายไปขวา |
| บน-ล่าง | String | upDown | การไล่ระดับสีจากบนลงล่าง |
| NW - SE | String | diagonal1 | การไล่ระดับสีลงตามแนวทแยงมุม |
| SW - NE | String | diagonal2 | การไล่ระดับสีขึ้นตามแนวทแยงมุม |
| รัศมี | String | radial | การไล่ระดับสีรัศมี |
eye_outer (Default 0)
| พารามิเตอร์ | ประเภท | ค่า | คำอธิบาย |
|---|---|---|---|
| eye_outer | String | eyeOuter0 | |
| eyeOuter1 | |||
| eyeOuter2 | |||
| eyeOuter3 | |||
| eyeOuter4 | |||
| eyeOuter5 | |||
| eyeOuter6 | |||
| eyeOuter7 | |||
| eyeOuter8 | |||
| eyeOuter9 |
eye_inner
| พารามิเตอร์ | ประเภท | ค่า | คำอธิบาย |
|---|---|---|---|
| eye_inner | String | eyeInner0 | |
| eyeInner1 | |||
| eyeInner2 | |||
| eyeInner3 | |||
| eyeInner4 | |||
| eyeInner5 | |||
| eyeInner6 | |||
| eyeInner7 | |||
| eyeInner8 | |||
| eyeInner9 |
QrData
| พารามิเตอร์ | ประเภท | ค่า | คำอธิบาย |
|---|---|---|---|
| qrData | String | pattern0 | |
| pattern1 | |||
| pattern2 | |||
| pattern3 | |||
| pattern4 | |||
| pattern5 | |||
| pattern6 | |||
| pattern7 | |||
| pattern8 | |||
| pattern9 | |||
| pattern10 | |||
| pattern11 |
Frame (Default : null)
| พารามิเตอร์ | ประเภท | ค่า | คำอธิบาย |
|---|---|---|---|
| frame | Number | 1 | |
| 2 | |||
| 3 |
5. ติดตามข้อมูล QR ของคุณ, จำนวนการสแกน, ประเทศ, เมือง, ประเภทอุปกรณ์
| URL | /data/qrid?period=month&tz=Asia/Singapore |
| วิธีการ | GET |
| การอนุญาต | Bearer API KEY |
| การตอบสนอง | JSON object of track data |
Request parameter
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| qrId | params | รหัสเฉพาะของ qr |
| period | query | “วัน” (ข้อมูลของวันนี้) “สัปดาห์” (ข้อมูลของสัปดาห์ปัจจุบัน) “เดือน” (ข้อมูลของเดือนปัจจุบัน) “เดือน” (ข้อมูลของปีปัจจุบัน) “ปี” (ข้อมูลรายปี) |
| tz | query | ค่าเริ่มต้น เอเชีย/สิงคโปร์ |
| Response | {
"data": {
"campaign": {
"scanLoop": false,
"bulk": false,
"scans": 5,
"scanCounter": 0,
"_id": "5f297b7b88c80a7e70afbbc5",
"qrId": "BXFO",
"qrType": "qr2",
"qrCategory": "url",
"shortUrl": "https://qrcode-tiger.com/BXFO",
"redirectUrl": "http://hello.com.vn",
"murlData": [],
"qrName": "Campaign BXFO",
"qrImage": "BXFO.png",
"owner": "5a84402c08004f37a2b87831",
"scanData": [],
"createdAt": "2020-08-04T15:15:07.057Z",
"updatedAt": "2020-08-29T00:39:47.416Z",
"__v": 0,
"user": null,
"id": "5f297b7b88c80a7e70afbbc5"
},
"city": [
{
"_id": {
"city": "New York"
},
"count": 3
},
{
"_id": {
"city": "Ho Chi Minh City"
},
"count": 2
}
],
"data": [
{
"_id": {
"device": "iOS",
"loc": "VN",
"city": "Ho Chi Minh City"
},
"count": 1
},
{
"_id": {
"device": null,
"loc": "NY",
"city": "New York"
},
"count": 3
},
{
"_id": {
"device": null,
"loc": "VN",
"city": "Ho Chi Minh City"
},
"count": 1
}
],
"country": [
{
"_id": {
"loc": "VN"
},
"count": 2
},
{
"_id": {
"loc": "NY"
},
"count": 3
}
],
"device": [
{
"_id": {
"device": "Android"
},
"count": 4
},
{
"_id": {
"device": "iOS"
},
"count": 1
}
],
"scans": 5,
"unique": {
"label": [
{
"month": "Aug",
"year": 2020
}
],
"scans": [
2
]
},
"graph": {
"label": [
{
"month": "Aug",
"year": 2020
}
],
"scans": [
5
]
}
}
} |
6. อัพโหลดโลโก้ของคุณ
| URL | /accounts/uploads/ |
| วิธีการ | POST |
| Content-Type | multipart/form-data |
| Form-Field | File |
| Response | Image file url {“qrUrl”: 1526460566643.png} |