QRTIGER API 문서
우리의 맞춤형 QR코드 API는 데이터 추적 시스템, 동적 QR코드 또는 대량의 QR코드가 포함된 맞춤형 QR코드 템플릿이 필요하고 CRM에 통합된 QR코드가 있어야 하는 브랜드를 위한 전문 솔루션을 제공합니다.
우리의 API는 'Mashape'에서 사용할 수 있으며 회원님이 언제든지 '문의하기'할 수있는 다른 질문에 대해 사용할 수 있습니다. 우리의 API는 전 세계에서 사용할 수 있으며 중국에서 사용할 수 있는 QR 코드가 필요한 경우 당사에 문의하세요. 모바일 결제를 위한 맞춤형 QR 코드도 만들 수 있습니다.
QRLD:
문서
이 YouTube 동영상에서 사용 방법을 확인하세요
QR 코드 생성
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 코드 생성
| URL | /api/qr/static |
| 방법 | POST |
| 권한 부여 | Bearer API KEY |
| 응답 | Binary Image File (PNG, SVG) |
요청 매개변수
| qrCategory | string | url | qrCategory는 url, Vcard, facebook 등과 같은 다른 유형의 qr을 정의합니다. 아래 qrCategory 테이블을 확인하세요. |
| text | String | https://qrcode-tiger.com | 원하는 리디렉션 URL이 QR에 포함됩니다. |
| size | number | 500 | QR의 크기 |
| logo | url | null | QR 중앙에 로고를 활성화하려면 로고 URL을 추가하세요. |
| colorDark | string | #5e0bf0 | QR코드 패턴의 색상 |
| backgroundColor | String | #ffffff | QR코드 배경색. (참고: 완전히 스캔 가능한 QR을 위해 항상 밝은 색상을 선택하세요.) |
| gradient | Boolean | false | 그라디언트 색상을 활성화하려면 “true”를 설정합니다. |
| grdType | Number | 0 (Left-to-Right) | grdType에 대한 아래 표를 확인하세요. |
| color01 | String | #5e0bf0 | QR코드 패턴의 그라디언트 색상 1 |
| color02 | String | #f30505 | QR코드 패턴의 그라디언트 색상 2 |
| 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 | 카테고리는 URL, Vcard, 페이스북 등과 같은 QR의 다른 유형을 정의합니다. 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 코드 생성
| URL | /api/campaign/ |
| 방법 | POST |
| 권한 부여 | Bearer API KEY |
| 응답 | Binary Image File (PNG, SVG) |
쿼리 매개변수
| 매개변수 | 유형 | 기본값 | 설명 | |
|---|---|---|---|---|
| qrUrl | String | https://qrcode-tiger.com | 원하는 리디렉션 URL이 QR에 포함됩니다. | |
| qrType | String | qr2 | QRType은 단일 리디렉션 URL 또는 다중 리디렉션 URL (“qr2" 또는 “murl”) 과 같은 qr의 동작을 정의합니다. | |
| qrCategory | String | url | qrCategory는 url, Vcard, facebook 등과 같은 다른 유형의 qr을 정의합니다. 아래 qrCategory 테이블을 확인하세요. | |
| qr: | JSON Object | 이 개체 내에서 색상, 데이터 패턴, 눈 등과 같은 회원님의 QR코드를 디자인하세요. | ||
| size | Number | 500 | QR의 크기 | |
| logo | String (url) | null | QR 중앙에 로고를 활성화하려면 로고 URL을 추가하세요. | |
| colorDark | String | #5e0bf0 | QR코드 패턴의 색상 | |
| backgroundColor | String | #ffffff | QR코드 배경색. (참고: 완전히 스캔 가능한 QR을 위해 항상 밝은 색상을 선택하세요.) | |
| gradient | Boolean | false | 그라디언트 색상을 활성화하려면 “true”를 설정합니다. | |
| grdType | Number | 0 (Left-to-Right) | grdType에 대한 아래 표를 확인하세요. | |
| color01 | String | #5e0bf0 | QR코드 패턴의 그라디언트 색상 1 | |
| color02 | String | #f30505 | QR코드 패턴의 그라디언트 색상 2 | |
| 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 | 위에서 아래로 그라데이션 흐름 |
| 북서 - 남동 | String | diagonal1 | 대각선 아래쪽으로 그라데이션 흐름 |
| 남서 - 북동 | 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 |
요청 매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| qrId | params | QR의 고유 ID |
| 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} |