QRTIGER API ドキュメント
当社のカスタムqrコードAPIは、データ追跡システムを備えたカスタムqrコードテンプレート、動的qrコードまたはqrコードを一括で使用し、qrコードをCRMに統合する必要があるブランド向けのプロフェッショナルなソリューションを提供します。
私たちのAPIは、あなたがいつでも「お問い合わせ」することができます他の質問のための「Mashape」で利用可能です私たちのAPIは、あなたが中国で利用可能なあなたのQRコードが必要な場合は、世界中で使用することができます、私達に連絡してください。また、モバイル決済用にカスタマイズされたQRコードを行うこともできます。
qrId:
ドキュメンテーション
このユーチューブビデオの使い方を確認してください
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 | qrカテゴリは、URL、Vカード、フェイスブックなどのような異なるタイプのQRを定義します。以下のqrカテゴリテーブルを確認してください。 |
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 | グラデーションカラーを有効にするには、「真」に設定します |
grdType | Number | 0 (Left-to-Right) | 以下の表でgrdTypeを確認してください |
color01 | String | #5e0bf0 | qrパターンのグラデーションカラー1 |
color02 | String | #f30505 | qrパターンのグラデーションカラー2 |
eye_color | Boolean | false | 目の色を変更するには "真" を設定します。 |
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、Vカード、フェイスブックなどのさまざまなタイプのqrを定義します。以下のqrカテゴリテーブルを確認してください。 |
例
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 | qrカテゴリは、URL、Vカード、フェイスブックなどのような異なるタイプのQRを定義します。以下のqrカテゴリテーブルを確認してください。 | |
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 | グラデーションカラーを有効にするには、「真」に設定します | |
grdType | Number | 0 (Left-to-Right) | 以下の表でgrdTypeを確認してください | |
color01 | String | #5e0bf0 | qrパターンのグラデーションカラー1 | |
color02 | String | #f30505 | qrパターンのグラデーションカラー2 | |
eye_color | Boolean | false | 目の色を変更するには "真" を設定します。 | |
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 |
要求パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
qrId | params | qrの一意のID |
period | query | "day" (現在の日付のデータ) "週" (現在の週のデータ) 「月」(当月の日データ) 「月」(今年の月のデータ) "年" (年間データ) |
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} |