Docs sur les API de QRTIGER
Notre API de codes QR personnalisés offre une solution professionnelle aux marques qui ont besoin de modèles de codes QR personnalisés avec un système de suivi des données, de codes QR dynamiques ou de codes QR en vrac et de codes QR intégrés dans leur CRM.
Notre API est disponible sur 'Mashape' et pour toute autre question, vous pouvez toujours nous contacter. Notre API peut être utilisée dans le monde entier, si vous avez besoin de vos codes QR disponibles en Chine, veuillez nous contacter. Nous pouvons également réaliser des QR codes personnalisés pour les paiements mobiles.
qrId:
Documentation
Regardez cette vidéo YouTube pour savoir comment l'utiliser
Créer un code QR
1.Connectez-vous d'abord et obtenez le Clé API pour autoriser Suivre les données --> Paramétrage du compte --> Clé API
Connectez-vous d'abord et obtenez le Clé API pour autoriser Suivre les données --> Paramétrage du compte --> Clé API
2.Add this API key in every req (GET/POST) as Authorization: Bearer Clé API
Add this API key in every req (GET/POST) as Authorization: Bearer Clé API
3. Générer un code QR statique et personnalisé
URL : | /api/qr/static |
Méthodes | POST |
Autorisation | Bearer API KEY |
Réponse | Binary Image File (PNG, SVG) |
Paramètre de requête
qrCategory | string | url | qrCategory définit différents types de qr comme url, Vcard, facebook, etc. Vérifiez ci-dessous le tableau qrCategory. |
text | String | https://qrcode-tiger.com | L'URL de redirection souhaitée sera intégrée dans le QR. |
size | number | 500 | Taille du qr |
logo | url | null | Ajouter n'importe quel logo url pour activer le logo au centre du QR |
colorDark | string | #5e0bf0 | Couleur des motifs qr |
backgroundColor | String | #ffffff | Couleur de fond du QR. (Remarque : choisissez toujours une couleur vive pour que le QR soit entièrement scannable). |
gradient | Boolean | false | Mettre " vrai " pour activer la couleur dégradée |
grdType | Number | 0 (Left-to-Right) | Vérifiez le tableau ci-dessous pour grdType |
color01 | String | #5e0bf0 | Dégradé de couleur 1 des motifs qr |
color02 | String | #f30505 | Dégradé de couleur 2 des motifs qr |
eye_color | Boolean | false | Mettre " vrai " pour changer la couleur des yeux |
eye_color01 | String | #5e0bf0 | Couleur de l'œil externe |
eye_color02 | String | #f30505 | Couleur de l'œil interne |
eye_outer | String | eyeOuter0 | Différents modèles de l'œil externe, consultez le tableau ci-dessous pour connaître tous les modèles. |
eye_inner | String | eyeInner0 | Différents modèles de l'œil interne, consultez le tableau ci-dessous pour tous les modèles. |
qrData | String | pattern0 | Différents modèles de données QR, consultez le tableau ci-dessous pour tous les modèles de conception. |
qrFormat | String | png | Télécharger un fichier image binaire de type "png" ou "svg". |
transparentBkg | Boolean | false | Si cette option est activée, le code QR aura un fond transparent. |
frame | Number | null | Si cette option est activée, le QR aura un cadre. Consultez le tableau ci-dessous pour connaître les modèles de cadre |
frameColor | String | null | Couleur du cadre change la couleur du texte du cadre |
frameText | String | SCAN ME | Texte du cadre affiché sur le cadre QR |
Exemple
URL : | /api/qr/static |
Méthodes | POST |
Paramètre | { "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" } |
Réponse | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Obtenir une liste de toutes les campagnes QR de différentes catégories QR
URL : | /api/campaign/ |
Méthodes | GET |
Autorisation | Bearer API KEY |
Réponse | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Paramètres de requête
Paramètre | Défaut | Description |
---|---|---|
page | 1 | numéro de la page |
limit | 5 | nombre de campagnes par page |
sort | 1 | Trier par Date(1) ou Nom(2) |
category | url | La catégorie définit différents types de qr tels que url, Vcard, facebook, etc. Vérifiez la table qrCategorie ci-dessous. |
Exemple
URL : | /api/campaign/?page=1&limit=5&sort=1&category=url |
Méthodes | GET |
Paramètre | { "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" } |
Réponse | { "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. Générer un code QR visuel dynamique et personnalisé
URL : | /api/campaign/ |
Méthodes | POST |
Autorisation | Bearer API KEY |
Réponse | Binary Image File (PNG, SVG) |
Paramètres de requête
Paramètre | Taper | Défaut | Description | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Votre URL de redirection souhaitée sera intégrée dans le QR | |
qrType | String | qr2 | qrType définit le comportement du qr comme une url de redirection unique ou une url de redirection multiple ("qr2" ou "murl"). | |
qrCategory | String | url | qrCategory définit différents types de qr comme url, Vcard, facebook, etc. Vérifiez ci-dessous le tableau qrCategory. | |
qr: | JSON Object | Concevez votre code QR comme la couleur, les modèles de données, les yeux, etc. dans cet objet. | ||
size | Number | 500 | Taille du qr | |
logo | String (url) | null | Ajouter n'importe quel logo url pour activer le logo au centre du QR | |
colorDark | String | #5e0bf0 | Couleur des motifs qr | |
backgroundColor | String | #ffffff | Couleur de fond du QR. (Remarque : choisissez toujours une couleur vive pour que le QR soit entièrement scannable). | |
gradient | Boolean | false | Mettre " vrai " pour activer la couleur dégradée | |
grdType | Number | 0 (Left-to-Right) | Vérifiez le tableau ci-dessous pour grdType | |
color01 | String | #5e0bf0 | Dégradé de couleur 1 des motifs qr | |
color02 | String | #f30505 | Dégradé de couleur 2 des motifs qr | |
eye_color | Boolean | false | Mettre " vrai " pour changer la couleur des yeux | |
eye_color01 | String | #5e0bf0 | Couleur de l'œil externe | |
eye_color02 | String | #f30505 | Couleur de l'œil interne | |
eye_outer | String | eyeOuter0 | Différents modèles de l'œil externe, consultez le tableau ci-dessous pour connaître tous les modèles. | |
eye_inner | String | eyeInner0 | Différents modèles de l'œil interne, consultez le tableau ci-dessous pour tous les modèles. | |
qrData | String | pattern0 | Différents modèles de données QR, consultez le tableau ci-dessous pour tous les modèles de conception. | |
qrFormat | String | png | Télécharger un fichier image binaire de type "png" ou "svg". | |
transparentBkg | Boolean | false | Si cette option est activée, le code QR aura un fond transparent. | |
frame | Number | null | Si cette option est activée, le QR aura un cadre. Consultez le tableau ci-dessous pour connaître les modèles de cadre | |
frameColor | String | null | Couleur du cadre change la couleur du texte du cadre | |
frameText | String | SCAN ME | Texte du cadre affiché sur le cadre QR |
Exemple
URL : | /api/campaign |
Méthodes | 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)
Paramètre | Taper | Évaluer | Description |
---|---|---|---|
Gauche droite | String | linear | Flux dégradé de gauche à droite |
Haut - Bas | String | upDown | Flux de gradient de haut en bas |
NW - SE | String | diagonal1 | Flux de gradient Diagonalement vers le bas |
SW - NE | String | diagonal2 | Flux de gradient Diagonalement vers le haut |
Radial | String | radial | Débit dégradé radialement |
eye_outer (Default 0)
Paramètre | Taper | Évaluer | Description |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Paramètre | Taper | Évaluer | Description |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Paramètre | Taper | Évaluer | Description |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Paramètre | Taper | Évaluer | Description |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Suivez vos données QR, le nombre de scans, le pays, la ville, le type d'appareil.
URL : | /data/qrid?period=month&tz=Asia/Singapore |
Méthodes | GET |
Autorisation | Bearer API KEY |
Réponse | JSON object of track data |
Paramètre de requête
Paramètre | Taper | Description |
---|---|---|
qrId | params | Identifiant unique du qr |
period | query | " jour " (Données du jour actuel) "week" (Données de la semaine en cours) " mois " (Données du mois en cours) " mois " (Données de l'année en cours) « année » (données annuelles) |
tz | query | Asie/Singapour par défaut |
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. Téléchargez votre logo
URL : | /accounts/uploads/ |
Méthodes | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |