Documentos de las API de QRTIGER
Nuestra API de códigos qr personalizados ofrece una solución profesional para las marcas que necesitan tener plantillas de códigos qr personalizados con sistema de seguimiento de datos, códigos qr dinámicos o códigos qr a granel y tener códigos qr integrados en su CRM.
Nuestra API está disponible en «Mashape» para cualquier otra pregunta, siempre puede «ponerse en contacto con nosotros». Nuestra API se puede utilizar en todo el mundo, si necesita sus códigos QR disponibles en China, contáctenos. También podemos hacer códigos QR personalizados para pagos móviles.
qrId:
Documentación
Mire este vídeo de YouTube sobre cómo usarlo
Crear código QR
1.Primero inicie sesión y obtenga el Clave API autorizar en Datos de seguimiento --> Configuración de la cuenta --> Clave API
Primero inicie sesión y obtenga el Clave API autorizar en Datos de seguimiento --> Configuración de la cuenta --> Clave API
2.Add this API key in every req (GET/POST) as Authorization: Bearer Clave API
Add this API key in every req (GET/POST) as Authorization: Bearer Clave API
3. Generar un código QR estático personalizado
URL | /api/qr/static |
Métodos | POST |
Autorización | Bearer API KEY |
Respuesta | Binary Image File (PNG, SVG) |
Parámetro de solicitud
qrCategory | string | url | qrCategory define diferentes tipos de qr como url, Vcard, facebook, etc. Compruebe la tabla de qrCategory que aparece a continuación. |
text | String | https://qrcode-tiger.com | Su URL de redirección deseada se incrustará en el QR |
size | number | 500 | Tamaño del qr |
logo | url | null | Agregue cualquier URL de logotipo para habilitar el logotipo en el centro de QR |
colorDark | string | #5e0bf0 | Color de los patrones qr |
backgroundColor | String | #ffffff | Color de fondo del QR. (Nota: elija siempre un color brillante para un QR totalmente escaneable) |
gradient | Boolean | false | Establece "true" para activar el color degradado |
grdType | Number | 0 (Left-to-Right) | Consulte la siguiente tabla para grdType |
color01 | String | #5e0bf0 | Color degradado 1 de patrones qr |
color02 | String | #f30505 | Color degradado 2 de patrones qr |
eye_color | Boolean | false | Establece “true” para cambiar el color de los ojos |
eye_color01 | String | #5e0bf0 | Color de la parte exterior del ojo |
eye_color02 | String | #f30505 | Color de la parte interior del ojo |
eye_outer | String | eyeOuter0 | Diferente diseño de la parte exterior del ojo, consulte la tabla a continuación para ver todos los patrones de diseño |
eye_inner | String | eyeInner0 | Diferente diseño del interior del ojo, consulte la tabla a continuación para ver todos los patrones de diseño |
qrData | String | pattern0 | Diferentes diseños de patrones de datos qr, revise la siguiente tabla para todos los patrones de diseño |
qrFormat | String | png | Descargar archivo de imagen binario de tipo "png" o "svg" |
transparentBkg | Boolean | false | Si se activa, el código QR tendrá un fondo transparente |
frame | Number | null | Si se habilita, el QR tendrá un marco. Verifique la tabla a continuación para ver el diseño del marco |
frameColor | String | null | Color del marco cambiar el color del texto del marco |
frameText | String | SCAN ME | Texto del marco que se muestra sobre el marco QR |
Ejemplo
URL | /api/qr/static |
Métodos | POST |
Parámetro | { "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" } |
Respuesta | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Obtenga una lista de todas las campañas QR de diferentes categorías QR
URL | /api/campaign/ |
Métodos | GET |
Autorización | Bearer API KEY |
Respuesta | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Parámetros de consulta
Parámetro | Por defecto | Descripción |
---|---|---|
page | 1 | no. de página |
limit | 5 | no. de campaña por página |
sort | 1 | Ordenar por Fecha(1) o Nombre(2) |
category | url | categoría define diferentes tipos de qr como url, Vcard, facebook, etc. Consulte la siguiente tabla qrCategory. |
Ejemplo
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Métodos | GET |
Parámetro | { "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" } |
Respuesta | { "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. Generar un código QR Visual dinámico personalizado
URL | /api/campaign/ |
Métodos | POST |
Autorización | Bearer API KEY |
Respuesta | Binary Image File (PNG, SVG) |
Parámetros de consulta
Parámetro | Tipo | Por defecto | Descripción | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Su URL de redirección de wishcred se insertará en QR | |
qrType | String | qr2 | qrType define el comportamiento del qr como url de redirección única o url de redirección múltiple ("qr2" o "murl") | |
qrCategory | String | url | qrCategory define diferentes tipos de qr como url, Vcard, facebook, etc. Compruebe la tabla de qrCategory que aparece a continuación. | |
qr: | JSON Object | Diseñe su código qr como color, patrones de datos, ojos, etc. dentro de este objeto | ||
size | Number | 500 | Tamaño del qr | |
logo | String (url) | null | Agregue cualquier URL de logotipo para habilitar el logotipo en el centro de QR | |
colorDark | String | #5e0bf0 | Color de los patrones qr | |
backgroundColor | String | #ffffff | Color de fondo del QR. (Nota: elija siempre un color brillante para un QR totalmente escaneable) | |
gradient | Boolean | false | Establece "true" para activar el color degradado | |
grdType | Number | 0 (Left-to-Right) | Consulte la siguiente tabla para grdType | |
color01 | String | #5e0bf0 | Color degradado 1 de patrones qr | |
color02 | String | #f30505 | Color degradado 2 de patrones qr | |
eye_color | Boolean | false | Establece “true” para cambiar el color de los ojos | |
eye_color01 | String | #5e0bf0 | Color de la parte exterior del ojo | |
eye_color02 | String | #f30505 | Color de la parte interior del ojo | |
eye_outer | String | eyeOuter0 | Diferente diseño de la parte exterior del ojo, consulte la tabla a continuación para ver todos los patrones de diseño | |
eye_inner | String | eyeInner0 | Diferente diseño del interior del ojo, consulte la tabla a continuación para ver todos los patrones de diseño | |
qrData | String | pattern0 | Diferentes diseños de patrones de datos qr, revise la siguiente tabla para todos los patrones de diseño | |
qrFormat | String | png | Descargar archivo de imagen binario de tipo "png" o "svg" | |
transparentBkg | Boolean | false | Si se activa, el código QR tendrá un fondo transparente | |
frame | Number | null | Si se habilita, el QR tendrá un marco. Verifique la tabla a continuación para ver el diseño del marco | |
frameColor | String | null | Color del marco cambiar el color del texto del marco | |
frameText | String | SCAN ME | Texto del marco que se muestra sobre el marco QR |
Ejemplo
URL | /api/campaign |
Métodos | 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)
Parámetro | Tipo | Valor | Descripción |
---|---|---|---|
Izquierda - Derecha | String | linear | Flujo gradual de izquierda a derecha |
Arriba - Abajo | String | upDown | Flujo gradual de arriba a abajo |
NW - SE | String | diagonal1 | Flujo gradual en diagonal hacia abajo |
SW - NE | String | diagonal2 | Flujo gradual en diagonal hacia arriba |
Radial | String | radial | Flujo gradual Radialmente |
eye_outer (Default 0)
Parámetro | Tipo | Valor | Descripción |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Parámetro | Tipo | Valor | Descripción |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Parámetro | Tipo | Valor | Descripción |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Parámetro | Tipo | Valor | Descripción |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Rastree sus datos QR, número de escaneos, país, ciudad, tipo de dispositivo
URL | /data/qrid?period=month&tz=Asia/Singapore |
Métodos | GET |
Autorización | Bearer API KEY |
Respuesta | JSON object of track data |
Parámetro de solicitud
Parámetro | Tipo | Descripción |
---|---|---|
qrId | params | Identificación única del qr |
period | query | “día” (Datos del día actual) "semana" (Datos de la semana actual) "mes" (Datos del mes actual) "meses" (Datos del año en curso) "año" (datos anuales) |
tz | query | Por defecto Asia/Singapur |
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. Cargue su logotipo
URL | /accounts/uploads/ |
Métodos | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |