QRTIGER API 文檔
我們的二維碼API能為品牌和企業提供專業的二維碼製作和大數據追蹤服務，包括二維碼追蹤數據系統、自定義二維碼模板、動態二維碼、批量二維碼以及將二維碼整合到CRM系統中。
我們的API 也在“Mashape" 上架，若是在應用過程中遇到任何問題，歡迎您隨時聯系我們。此API可在全世界多個國家和區域使用，包括中国。我們也支持移動端自定義二維碼製作，以及移動支付。
qrId:
文檔
查看這個 YouTube 視頻，了解如何使用它
创建二维码
1.首先登錄並獲取 API key 授權 數據概覽 --> 帳户設置 --> API key
首先登錄並獲取 API key 授權 數據概覽 --> 帳户設置 --> API key
2.Add this API key in every req (GET/POST) as Authorization: Bearer API key
Add this API key in every req (GET/POST) as Authorization: Bearer API key
3. 生成自定義靜態二維碼
| 你的網址 | /api/qr/static |
| 方法 | POST |
| 授權 | Bearer API KEY |
| Response | Binary Image File (PNG, SVG) |
請求參數
| qrCategory | string | url | 二維碼按功能分為不同類型，例如：網址鏈接，電子名片等。查看下方不同類型的二維碼列表。 |
| text | String | https://qrcode-tiger.com | 您想要跳轉的URL將被嵌入到此二維碼中。 |
| size | number | 500 | 二維碼尺寸 |
| logo | url | null | 添加的logo將顯示在二維碼圖片正中間 |
| colorDark | string | #5e0bf0 | 二維碼的顏色 |
| backgroundColor | String | #ffffff | 二維碼的背景顏色（註意：為確保二維碼識別效果，請盡量選擇亮色背景) |
| gradient | Boolean | false | 設置 「是」 ，以應用漸變顏色 |
| grdType | Number | 0 (Left-to-Right) | 查看下方漸變模式列表 |
| color01 | String | #5e0bf0 | 二維碼樣式的漸變顏色1 |
| color02 | String | #f30505 | 二維碼樣式的漸變顏色2 |
| eye_color | Boolean | false | 設置 「是」 更改圖眼顏色 |
| eye_color01 | String | #5e0bf0 | 外部圖眼的顏色 |
| eye_color02 | String | #f30505 | 內部圖眼的顏色 |
| eye_outer | String | eyeOuter0 | 外部圖眼的不同設計，從下方列表查看所有設計 |
| eye_inner | String | eyeInner0 | 內部圖眼的不同設計，從下方列表查看所有設計 |
| qrData | String | pattern0 | 二維碼數據樣式的不同設計，從下方列表查看所有設計 |
| qrFormat | String | png | 下載「png」或「svg」格式的二維碼圖片 |
| transparentBkg | Boolean | false | 如果應用，二維碼的背景將會是透明背景。 |
| frame | Number | null | 如果啟用，二維碼將增加一個邊框，點擊查看下方的二維碼邊框。 |
| frameColor | String | null | 二維碼邊框顏色的變化會改變邊框文本的顏色 |
| frameText | String | SCAN ME | 邊框文本顯示在二維碼邊框上 |
示例
| 你的網址 | /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"
} |
| Response | {
"data": "base 64 QR image data",
"url": "1601477992984.png"
} |
4. 獲取不同種類二維碼的所有數據列表
| 你的網址 | /api/campaign/ |
| 方法 | GET |
| 授權 | Bearer API KEY |
| Response | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
查詢參數
| 参数 | 默認設置 | 說明 |
|---|---|---|
| page | 1 | 頁數 |
| limit | 5 | 每頁展示的二維碼數量 |
| sort | 1 | 根據日期（1）或名稱（2）排序 |
| category | 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"
} |
| Response | {
"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. 生成一個自定義視覺動態二維碼
| 你的網址 | /api/campaign/ |
| 方法 | POST |
| 授權 | Bearer API KEY |
| Response | Binary Image File (PNG, SVG) |
查詢參數
| 参数 | Type | 默認設置 | 說明 | |
|---|---|---|---|---|
| qrUrl | String | https://qrcode-tiger.com | 您想要的跳轉的URL將被嵌入到此二維碼中。 | |
| qrType | String | qr2 | 不同類型的二維碼跳轉方式也不同，例如跳轉至單個網址，或跳轉至多個網址 。 | |
| qrCategory | String | url | 二維碼按功能分為不同類型，例如：網址鏈接，電子名片等。查看下方不同類型的二維碼列表。 | |
| qr: | JSON Object | 設計您的二維碼的顏色，樣式，圖眼等。 | ||
| size | Number | 500 | 二維碼尺寸 | |
| logo | String (url) | null | 添加的logo將顯示在二維碼圖片正中間 | |
| colorDark | String | #5e0bf0 | 二維碼的顏色 | |
| backgroundColor | String | #ffffff | 二維碼的背景顏色（註意：為確保二維碼識別效果，請盡量選擇亮色背景) | |
| gradient | Boolean | false | 設置 「是」 ，以應用漸變顏色 | |
| grdType | Number | 0 (Left-to-Right) | 查看下方漸變模式列表 | |
| color01 | String | #5e0bf0 | 二維碼樣式的漸變顏色1 | |
| color02 | String | #f30505 | 二維碼樣式的漸變顏色2 | |
| eye_color | Boolean | false | 設置 「是」 更改圖眼顏色 | |
| eye_color01 | String | #5e0bf0 | 外部圖眼的顏色 | |
| eye_color02 | String | #f30505 | 內部圖眼的顏色 | |
| eye_outer | String | eyeOuter0 | 外部圖眼的不同設計，從下方列表查看所有設計 | |
| eye_inner | String | eyeInner0 | 內部圖眼的不同設計，從下方列表查看所有設計 | |
| qrData | String | pattern0 | 二維碼數據樣式的不同設計，從下方列表查看所有設計 | |
| qrFormat | String | png | 下載「png」或「svg」格式的二維碼圖片 | |
| transparentBkg | Boolean | false | 如果應用，二維碼的背景將會是透明背景。 | |
| frame | Number | null | 如果啟用，二維碼將增加一個邊框，點擊查看下方的二維碼邊框。 | |
| frameColor | String | null | 二維碼邊框顏色的變化會改變邊框文本的顏色 | |
| frameText | String | SCAN ME | 邊框文本顯示在二維碼邊框上 |
示例
| 你的網址 | /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)
| 参数 | Type | Value | 說明 |
|---|---|---|---|
| 左-右 | String | linear | 顏色漸變從左至右 |
| 从上至下 | String | upDown | 漸變顏色從上至下 |
| 西北 - 東南 | String | diagonal1 | 從西北向東南顏色漸變 |
| 西南-東北 | String | diagonal2 | 從西南向東北顏色漸變 |
| 中心漸變 | String | radial | 漸變顏色中心漸變 |
eye_outer (Default 0)
| 参数 | Type | Value | 說明 |
|---|---|---|---|
| eye_outer | String | eyeOuter0 | |
| eyeOuter1 | |||
| eyeOuter2 | |||
| eyeOuter3 | |||
| eyeOuter4 | |||
| eyeOuter5 | |||
| eyeOuter6 | |||
| eyeOuter7 | |||
| eyeOuter8 | |||
| eyeOuter9 |
eye_inner
| 参数 | Type | Value | 說明 |
|---|---|---|---|
| eye_inner | String | eyeInner0 | |
| eyeInner1 | |||
| eyeInner2 | |||
| eyeInner3 | |||
| eyeInner4 | |||
| eyeInner5 | |||
| eyeInner6 | |||
| eyeInner7 | |||
| eyeInner8 | |||
| eyeInner9 |
QrData
| 参数 | Type | Value | 說明 |
|---|---|---|---|
| qrData | String | pattern0 | |
| pattern1 | |||
| pattern2 | |||
| pattern3 | |||
| pattern4 | |||
| pattern5 | |||
| pattern6 | |||
| pattern7 | |||
| pattern8 | |||
| pattern9 | |||
| pattern10 | |||
| pattern11 |
Frame (Default : null)
| 参数 | Type | Value | 說明 |
|---|---|---|---|
| frame | Number | 1 | |
| 2 | |||
| 3 |
5. 追蹤二維碼掃描數據：掃描數量，掃描位置，掃描時間，掃描設備等。
| 你的網址 | /data/qrid?period=month&tz=Asia/Singapore |
| 方法 | GET |
| 授權 | Bearer API KEY |
| Response | JSON object of track data |
請求參數
| 参数 | Type | 說明 |
|---|---|---|
| qrId | params | 二維碼的唯一識別編號 |
| 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. 上傳您的logo
| 你的網址 | /accounts/uploads/ |
| 方法 | POST |
| Content-Type | multipart/form-data |
| Form-Field | File |
| Response | Image file url {“qrUrl”: 1526460566643.png} |