QRTIGER API Dokumentation
Vores brugerdefinerede API for QR-koder tilbyder en professionel løsning til mærker der har behov for tilpassede QR-kodeskabeloner med datasporingssystem, dynamiske QR-koder, eller QR-koder i massevis og muligheden for at få QR-koder integreret i deres CRM.
Vores API er tilgængelig på "Mashape" og for alle andre spørgsmål kan du altid "kontakte os". Vores API kan bruges i hele verden. Hvis du har brug for dine QR-koder i Kina, bedes du kontakte os. Vi kan også lave tilpassede QR-koder til mobilbetalinger.
qrid:
Dokumentation
Se denne YouTube video om hvordan du bruger den
Opret QR-kode
1.Log først ind og få API-nøgle at give tilladelse til Spor data --> Kontoindstillinger --> API-nøgle
Log først ind og få API-nøgle at give tilladelse til Spor data --> Kontoindstillinger --> API-nøgle
2.Add this API key in every req (GET/POST) as Authorization: Bearer API-nøgle
Add this API key in every req (GET/POST) as Authorization: Bearer API-nøgle
3. Generer Statisk brugerdefineret QR-kode
URL | /api/qr/static |
Metoder | POST |
Godkendelse | Bearer API KEY |
Svar | Binary Image File (PNG, SVG) |
Anmodningsparameter
qrCategory | string | url | qrCategory definerer forskellige typer QR som url, vCard, Facebook osv. Tjek nedenstående qrCategory tabel. |
text | String | https://qrcode-tiger.com | Din ønskede omdirigerings URL-adresse vil blive integreret i QR |
size | number | 500 | Størrelse på QR |
logo | url | null | Tilføj et hvilket som helst logo url for at aktivere logoet i midten af QR |
colorDark | string | #5e0bf0 | Farven på QR mønstrene |
backgroundColor | String | #ffffff | Baggrundsfarve for QR. (Bemærk: Vælg altid en lys farve for at få en QR, der kan scannes helt) |
gradient | Boolean | false | Sæt til "sand" for at aktivere gradientfarve |
grdType | Number | 0 (Left-to-Right) | Tjek nedenstående tabel for grdType |
color01 | String | #5e0bf0 | Gradientfarve 1 på QR mønstre |
color02 | String | #f30505 | Gradientfarve 2 på QR mønstre |
eye_color | Boolean | false | Sæt til "sandt" for at ændre øjenfarven |
eye_color01 | String | #5e0bf0 | Farven på det ydre øje |
eye_color02 | String | #f30505 | Farven på det indre øje |
eye_outer | String | eyeOuter0 | Forskelligt design af ydre øje, tjek nedenstående tabel for alle designmønstre |
eye_inner | String | eyeInner0 | Forskelligt design af indre øje, tjek nedenstående tabel for alle designmønstre |
qrData | String | pattern0 | Forskellige designs af qr datamønstre, tjek nedenstående tabel for alle designmønstre |
qrFormat | String | png | Download binær billedfil af typen "png"eller "svg" |
transparentBkg | Boolean | false | Hvis aktiveret vil QR-koden have gennemsigtig baggrund |
frame | Number | null | Hvis aktiveret, vil QR have en ramme. Tjek nedenstående tabel for design for rammerne |
frameColor | String | null | Rammefarve skift farven på rammeteksten |
frameText | String | SCAN ME | Rammetekst vist over QR rammen |
Eksempel
URL | /api/qr/static |
Metoder | POST |
Parameter | { "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" } |
Svar | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Få en liste over alle QR-kampagner i de forskellige QR-kategorier
URL | /api/campaign/ |
Metoder | GET |
Godkendelse | Bearer API KEY |
Svar | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Forespørgselsparametre
Parameter | Standard | Beskrivelse |
---|---|---|
page | 1 | antal sider |
limit | 5 | antal kampagner pr. side |
sort | 1 | Sorter efter Dato(1) eller Navn(2) |
category | url | kategori definerer forskellige typer QR som url, vCard, Facebook, osv. Tjek qrCategory tabellen nedenfor. |
Eksempel
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Metoder | GET |
Parameter | { "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" } |
Svar | { "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. Generer en Dynamisk tilpasset Visuel QR-kode
URL | /api/campaign/ |
Metoder | POST |
Godkendelse | Bearer API KEY |
Svar | Binary Image File (PNG, SVG) |
Forespørgselsparametre
Parameter | Type | Standard | Beskrivelse | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Din ønskede omdirigerings URL-adresse vil blive indlejret i QR | |
qrType | String | qr2 | qrType definerer adfærd for qr, som et enkelt omdirigeret url, eller multi omdirigeret url ("qr2" eller "murl") | |
qrCategory | String | url | qrCategory definerer forskellige typer QR som url, vCard, Facebook osv. Tjek nedenstående qrCategory tabel. | |
qr: | JSON Object | Design din QR-kode med farve, datamønstre, øjne og mere for dette objekt | ||
size | Number | 500 | Størrelse på QR | |
logo | String (url) | null | Tilføj et hvilket som helst logo url for at aktivere logoet i midten af QR | |
colorDark | String | #5e0bf0 | Farven på QR mønstrene | |
backgroundColor | String | #ffffff | Baggrundsfarve for QR. (Bemærk: Vælg altid en lys farve for at få en QR, der kan scannes helt) | |
gradient | Boolean | false | Sæt til "sand" for at aktivere gradientfarve | |
grdType | Number | 0 (Left-to-Right) | Tjek nedenstående tabel for grdType | |
color01 | String | #5e0bf0 | Gradientfarve 1 på QR mønstre | |
color02 | String | #f30505 | Gradientfarve 2 på QR mønstre | |
eye_color | Boolean | false | Sæt til "sandt" for at ændre øjenfarven | |
eye_color01 | String | #5e0bf0 | Farven på det ydre øje | |
eye_color02 | String | #f30505 | Farven på det indre øje | |
eye_outer | String | eyeOuter0 | Forskelligt design af ydre øje, tjek nedenstående tabel for alle designmønstre | |
eye_inner | String | eyeInner0 | Forskelligt design af indre øje, tjek nedenstående tabel for alle designmønstre | |
qrData | String | pattern0 | Forskellige designs af qr datamønstre, tjek nedenstående tabel for alle designmønstre | |
qrFormat | String | png | Download binær billedfil af typen "png"eller "svg" | |
transparentBkg | Boolean | false | Hvis aktiveret vil QR-koden have gennemsigtig baggrund | |
frame | Number | null | Hvis aktiveret, vil QR have en ramme. Tjek nedenstående tabel for design for rammerne | |
frameColor | String | null | Rammefarve skift farven på rammeteksten | |
frameText | String | SCAN ME | Rammetekst vist over QR rammen |
Eksempel
URL | /api/campaign |
Metoder | 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)
Parameter | Type | Værdi | Beskrivelse |
---|---|---|---|
Venstre - Højre | String | linear | Gradient retning fra venstre mod højre |
Top - Bund | String | upDown | Gradient retning fra Top til Bund |
NV - SØ | String | diagonal1 | Gradient med retning diagonalt nedad |
SV - NØ | String | diagonal2 | Gradient med retning diagonalt opad |
Radial | String | radial | Radial gradient retning |
eye_outer (Default 0)
Parameter | Type | Værdi | Beskrivelse |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Parameter | Type | Værdi | Beskrivelse |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Parameter | Type | Værdi | Beskrivelse |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Parameter | Type | Værdi | Beskrivelse |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Spor dine QR-data, Antal scanninger, Land, By, Enhedstype
URL | /data/qrid?period=month&tz=Asia/Singapore |
Metoder | GET |
Godkendelse | Bearer API KEY |
Svar | JSON object of track data |
Anmodningsparameter
Parameter | Type | Beskrivelse |
---|---|---|
qrId | params | Unikt id for qr |
period | query | "dag" (Data for den aktuelle dag) "uge" (Data for den aktuelle uge) "måned" (Data for den aktuelle måned) "måneder" (Data for nuværende år) "år" (Årlige data) |
tz | query | Standard Asien/Singapore |
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. Upload dit logo
URL | /accounts/uploads/ |
Metoder | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |