Документация по API QRTIGER

Наш собственный API-интерфейс qr-кода предлагает профессиональное решение для брендов, которым необходимо иметь настраиваемые шаблоны qr-кода с системой отслеживания данных, динамические qr-коды или массовые qr-коды, а также интегрировать qr-коды в свою CRM.

Наш API доступен на «Mashape». По любым другим вопросам вы всегда можете «связаться с нами». Наш API можно использовать по всему миру. Если вам нужны QR-коды, доступные в Китае, свяжитесь с нами. Мы также можем сделать индивидуальный QR-код для мобильных платежей.

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

Документация

Посмотрите это видео на YouTube о том, как его использовать

Создать QR-код

1.

Сначала войдите в систему и получите Ключ API авторизоваться Данные отслеживания --> Настройка учетной записи --> Ключ API

2.

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)
Параметр запроса
qrCategorystringurlqrCategory определяет различные типы qr, такие как url, Vcard, facebook и т.д. Проверьте ниже таблицу qrCategory.
textStringhttps://qrcode-tiger.comВаш желаемый URL-адрес перенаправления будет встроен в QR
sizenumber500Размер qr
logourlnullДобавьте любой URL-адрес логотипа, чтобы включить логотип в центре QR.
colorDarkstring#5e0bf0Цвет узоров qr
backgroundColorString#ffffffЦвет фона QR. (Примечание: всегда выбирайте яркий цвет для полностью сканируемого QR)
gradientBooleanfalseУстановите значение "true", чтобы включить градиентный цвет
grdTypeNumber0 (Left-to-Right)Проверьте таблицу ниже для grdType
color01String#5e0bf0Цвет градиента 1 шаблона qr
color02String#f30505Цвет градиента 2 шаблонов qr
eye_colorBooleanfalseУстановите значение "true", чтобы изменить цвет глаз
eye_color01String#5e0bf0Цвет внешнего квадрата
eye_color02String#f30505Цвет внутреннего квадрата
eye_outerStringeyeOuter0Различный дизайн внешнего квадрата, см. таблицу ниже для всех шаблонов дизайна
eye_innerStringeyeInner0Различный дизайн внутреннего квадрата, см. таблицу ниже для всех шаблонов дизайна
qrDataStringpattern0Различный дизайн шаблонов данных qr, проверьте таблицу ниже для всех шаблонов дизайна
qrFormatStringpngЗагрузите двоичный файл изображения типа «png» или «svg»
transparentBkgBooleanfalseЕсли включить, фон QR кода будет прозрачным
frameNumbernullЕсли включить qr, то он будет состоять из рамки. Проверьте таблицу ниже для дизайна рамки
frameColorStringnullЦвет рамки изменить цвет текста рамки
frameTextStringSCAN 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"
}
Ответ
example 5
{
  "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
Параметры запроса
ПараметрПо умолчаниюОписание
page1номер страницы
limit5кол-во кампаний на странице
sort1Сортировать по дате(1) или названию(2)
categoryurlкатегория определяет другой тип qr, такой как url, Vcard, facebook и т. д. Проверьте ниже таблицу qrCategory.
Пример
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)
Параметры запроса
ПараметрТипПо умолчаниюОписание
qrUrlStringhttps://qrcode-tiger.comВаш желаемый URL-адрес перенаправления будет встроен в QR
qrTypeStringqr2qrType определяет поведение qr, например один url-адрес перенаправления или url-адрес с несколькими перенаправлениями («qr2» или «murl»)
qrCategoryStringurlqrCategory определяет различные типы qr, такие как url, Vcard, facebook и т.д. Проверьте ниже таблицу qrCategory.
qr:JSON ObjectСоздайте свой qr-код, выберите цвет, шаблоны данных, квадраты и т.д. в этом объекте.
sizeNumber500Размер qr
logoString (url)nullДобавьте любой URL-адрес логотипа, чтобы включить логотип в центре QR.
colorDarkString#5e0bf0Цвет узоров qr
backgroundColorString#ffffffЦвет фона QR. (Примечание: всегда выбирайте яркий цвет для полностью сканируемого QR)
gradientBooleanfalseУстановите значение "true", чтобы включить градиентный цвет
grdTypeNumber0 (Left-to-Right)Проверьте таблицу ниже для grdType
color01String#5e0bf0Цвет градиента 1 шаблона qr
color02String#f30505Цвет градиента 2 шаблонов qr
eye_colorBooleanfalseУстановите значение "true", чтобы изменить цвет глаз
eye_color01String#5e0bf0Цвет внешнего квадрата
eye_color02String#f30505Цвет внутреннего квадрата
eye_outerStringeyeOuter0Различный дизайн внешнего квадрата, см. таблицу ниже для всех шаблонов дизайна
eye_innerStringeyeInner0Различный дизайн внутреннего квадрата, см. таблицу ниже для всех шаблонов дизайна
qrDataStringpattern0Различный дизайн шаблонов данных qr, проверьте таблицу ниже для всех шаблонов дизайна
qrFormatStringpngЗагрузите двоичный файл изображения типа «png» или «svg»
transparentBkgBooleanfalseЕсли включить, фон QR кода будет прозрачным
frameNumbernullЕсли включить qr, то он будет состоять из рамки. Проверьте таблицу ниже для дизайна рамки
frameColorStringnullЦвет рамки изменить цвет текста рамки
frameTextStringSCAN 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
example 5
grdType (Default 0)
ПараметрТипСтоимостьОписание
Левый - ПравыйStringlinearГрадиентный поток слева направо
Верх - НизStringupDownГрадиентный поток сверху вниз
СЗ - ЮВStringdiagonal1Градиентный поток по диагонали вниз
ЮЗ – СВStringdiagonal2Градиентный поток по диагонали вверх
РадиальныйStringradialГрадиентный поток по радиусу
eye_outer (Default 0)
ПараметрТипСтоимостьОписание
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
ПараметрТипСтоимостьОписание
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
ПараметрТипСтоимостьОписание
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
ПараметрТипСтоимостьОписание
frameNumber1
2
3
5. Отслеживайте свои QR-данные, количество сканирований, страну, город, тип устройства
URL/data/qrid?period=month&tz=Asia/Singapore
МетодыGET
АвторизацияBearer API KEY
ОтветJSON object of track data
Параметр запроса
ПараметрТипОписание
qrIdparamsУникальный id qr
periodquery
«день» (данные текущего дня)
«week» (данные текущей недели)
«month» (данные текущего месяца)
«месяцы» (данные текущего года)
"год" (данные за год)
tzqueryПо умолчанию Азия/Сингапур
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-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}
Pусский
Этот генератор QR-кода является зарегистрированным товарным знаком FREEQR PTE. LTD..
QR-код является товарным знаком DENSO WAVE INCORPORATED. © 2024 www.free-qr-code-generator.com