Documentos de APIs QRTIGER

A nossa API de código QR personalizada oferece uma solução profissional para marcas que necessitam de ter modelos de código QR personalizados com sistema de rastreio de dados, códigos QR dinâmicos ou códigos QR em massa, e ter os códigos QR integrados no seu CRM.

A nossa API e está disponível em 'Mashape'. Para quaisquer outras questões pode sempre 'contactar-nos'. A nossa API pode ser utilizada em todo o mundo, e se precisar dos seus códigos QR disponíveis na China, por favor contacte-nos. Podemos também fazer códigos QR personalizados para pagamentos móveis.

qrId:
example 1
example 2
example 3
example 4
example 5

Documentação

Veja este vídeo do YouTube sobre como utilizá-lo

Gerar Código QR

1.

Primeiro faça login e obtenha o Chave API autorizar em Rastrear Dados --> Definição de conta --> Chave API

2.

Add this API key in every req (GET/POST) as Authorization: Bearer Chave API

3. Gerar código QR personalizado estático
URL/api/qr/static
MétodosPOST
AutorizaçãoBearer API KEY
RespostaBinary Image File (PNG, SVG)
Parâmetro de pedido
qrCategorystringurlCategoriaQR define diferentes tipos de QR como URL, Vcard, Facebook, etc. Verifique abaixo a tabela CategoriaQR.
textStringhttps://qrcode-tiger.comO seu URL de redireccionamento desejado será incorporado no QR
sizenumber500Tamanho do QR
logourlnullAdicionar qualquer URL de logotipo para ativar o logotipo no centro de QR
colorDarkstring#5e0bf0Cor dos padrões QR
backgroundColorString#ffffffCor de fundo do QR. (Nota: Escolha sempre uma cor clara para um QR totalmente digitalizável)
gradientBooleanfalseDefinir "verdadeiro" para permitir gradiente de cor
grdTypeNumber0 (Left-to-Right)Verifique a tabela abaixo para o grdType
color01String#5e0bf0Cor gradiente 1 dos padrões QR
color02String#f30505Cor gradiente 2 dos padrões QR
eye_colorBooleanfalseDefinir "verdadeiro" para mudar a cor dos olhos
eye_color01String#5e0bf0Cor da esclera do olho
eye_color02String#f30505Cor do interior do olho
eye_outerStringeyeOuter0Desenho diferente do olho exterior, verificar a tabela abaixo para todos os padrões de desenho
eye_innerStringeyeInner0Design diferente do interior do olho, verifique a tabela abaixo para todos os padrões de design
qrDataStringpattern0Desenho diferente de padrões de dados QR, verifique a tabela abaixo para todos os padrões de desenho
qrFormatStringpngFaça o download do ficheiro de imagem binário tipo "PNG" ou "SVG"
transparentBkgBooleanfalseSe activado, o código QR terá um fundo transparente
frameNumbernullSe activado, o QR terá uma moldura. Verifique a tabela abaixo para os tipos de moldura
frameColorStringnullA cor da moldura muda a cor do texto da moldura
frameTextStringSCAN METexto da moldura é mostrado sobre a moldura QR
Exemplo
URL/api/qr/static
MétodosPOST
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"
}
Resposta
example 5
{
  "data": "base 64 QR image data",
  "url": "1601477992984.png"
}
4. Obtenha uma lista de todas as campanhas de QR, de diferentes categorias de QR
URL/api/campaign/
MétodosGET
AutorizaçãoBearer API KEY
RespostaJSON object of QR list
GET /campaign/?page=1&limit=5&sort=1
Parâmetros de consulta
ParâmetroPredefiniçãoDescrição
page1nº de página
limit5nº de campanhas por página
sort1Ordenar por Data(1) ou Nome(2)
categoryurlcategorias definem diferentes tipos de QR como URL, Vcard, Facebook, etc. Verifique abaixo a tabela CategoriaQR.
Exemplo
URL/api/campaign/?page=1&limit=5&sort=1&category=url
MétodosGET
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"
}
Resposta
{
  "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. Gerar um código QR visual personalizado dinâmico
URL/api/campaign/
MétodosPOST
AutorizaçãoBearer API KEY
RespostaBinary Image File (PNG, SVG)
Parâmetros de consulta
ParâmetroTipoPredefiniçãoDescrição
qrUrlStringhttps://qrcode-tiger.comO seu URL de redireccionamento desejado será incorporado no QR
qrTypeStringqr2qrType define o comportamento do QR como URL simples ou URL multi redireccionamento ("QR2" ou "MURL")
qrCategoryStringurlCategoriaQR define diferentes tipos de QR como URL, Vcard, Facebook, etc. Verifique abaixo a tabela CategoriaQR.
qr:JSON ObjectPersonalize o seu código QR como cor, padrões de dados, olhos, etc. dentro deste objeto
sizeNumber500Tamanho do QR
logoString (url)nullAdicionar qualquer URL de logotipo para ativar o logotipo no centro de QR
colorDarkString#5e0bf0Cor dos padrões QR
backgroundColorString#ffffffCor de fundo do QR. (Nota: Escolha sempre uma cor clara para um QR totalmente digitalizável)
gradientBooleanfalseDefinir "verdadeiro" para permitir gradiente de cor
grdTypeNumber0 (Left-to-Right)Verifique a tabela abaixo para o grdType
color01String#5e0bf0Cor gradiente 1 dos padrões QR
color02String#f30505Cor gradiente 2 dos padrões QR
eye_colorBooleanfalseDefinir "verdadeiro" para mudar a cor dos olhos
eye_color01String#5e0bf0Cor da esclera do olho
eye_color02String#f30505Cor do interior do olho
eye_outerStringeyeOuter0Desenho diferente do olho exterior, verificar a tabela abaixo para todos os padrões de desenho
eye_innerStringeyeInner0Design diferente do interior do olho, verifique a tabela abaixo para todos os padrões de design
qrDataStringpattern0Desenho diferente de padrões de dados QR, verifique a tabela abaixo para todos os padrões de desenho
qrFormatStringpngFaça o download do ficheiro de imagem binário tipo "PNG" ou "SVG"
transparentBkgBooleanfalseSe activado, o código QR terá um fundo transparente
frameNumbernullSe activado, o QR terá uma moldura. Verifique a tabela abaixo para os tipos de moldura
frameColorStringnullA cor da moldura muda a cor do texto da moldura
frameTextStringSCAN METexto da moldura é mostrado sobre a moldura QR
Exemplo
URL/api/campaign
MétodosPOST
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
example 5
grdType (Default 0)
ParâmetroTipoValorDescrição
Esquerda - DireitaStringlinearFluxo gradual da esquerda para a direita
Superior - InferiorStringupDownFluxo gradiente de cima para baixo
NO - SEStringdiagonal1Fluxo gradiente Diagonalmente para Baixo
SO - NEStringdiagonal2Fluxo gradual Diagonalmente para Cima
RadialStringradialFluxo gradiente Radialmente
eye_outer (Default 0)
ParâmetroTipoValorDescrição
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
ParâmetroTipoValorDescrição
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
ParâmetroTipoValorDescrição
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
ParâmetroTipoValorDescrição
frameNumber1
2
3
5. Rastreie os seus Dados QR, Nº de digitalizações, País, Cidade, Tipo de Dispositivo
URL/data/qrid?period=month&tz=Asia/Singapore
MétodosGET
AutorizaçãoBearer API KEY
RespostaJSON object of track data
Parâmetro de pedido
ParâmetroTipoDescrição
qrIdparamsIdentificação única do QR
periodquery
"dia" (Dados do próprio dia)
"semana" (Dados da própria semana)
"mês" (Dados do próprio mês)
"meses" (Dados do ano em curso)
"ano" (Dados anuais)
tzqueryPadrão Ásia/Singapura
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. Carregue o seu logotipo
URL/accounts/uploads/
MétodosPOST
Content-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}