Dokumenty API QRTIGER
Nasz niestandardowy interfejs API kodu qr oferuje profesjonalne rozwiązanie dla marek, które muszą posiadać niestandardowe szablony kodów qr z systemem śledzenia danych, dynamicznymi kodami qr lub kodami qr w zbiorczej ilości oraz mają kody qr zintegrowane z systemem CRM.
Nasz API i jest dostępny na „Mashape” dla innych pytań zawsze możesz „skontaktować się z nami” nasz API może być używany na całym świecie, jeśli potrzebujesz swoich kodów QR dostępnych w Chinach, skontaktuj się z nami. Możemy również zrobić spersonalizowany kod QR dla płatności mobilnych.
QRID:
dokumentacja
Sprawdź ten film z YouTube, jak go używać
Utwórz kod QR
1.Najpierw zaloguj się i uzyskaj Klucz API zezwalać na Dane śledzenia --> Ustawienie konta --> Klucz API
Najpierw zaloguj się i uzyskaj Klucz API zezwalać na Dane śledzenia --> Ustawienie konta --> Klucz API
2.Add this API key in every req (GET/POST) as Authorization: Bearer Klucz API
Add this API key in every req (GET/POST) as Authorization: Bearer Klucz API
3. Generowanie statycznego niestandardowego kodu QR
URL | /api/qr/static |
Metody | POST |
Autoryzacja | Bearer API KEY |
Odpowiedź | Binary Image File (PNG, SVG) |
Parametr żądanie
qrCategory | string | url | QRCategory zdefiniować inny typ qr jak url, Vcard, facebook, itp Sprawdź poniżej QRCategory tabeli. |
text | String | https://qrcode-tiger.com | Twój żądany adres URL przekierowania zostanie osadzony w QR |
size | number | 500 | Rozmiar qr |
logo | url | null | Dodaj dowolny adres URL logo, aby włączyć logo w centrum QR |
colorDark | string | #5e0bf0 | Kolor wzorów qr |
backgroundColor | String | #ffffff | Kolor tła QR. (Uwaga: zawsze wybieraj jasny kolor, aby w pełni zeskanować QR) |
gradient | Boolean | false | Ustaw „true”, aby włączyć kolor gradientu |
grdType | Number | 0 (Left-to-Right) | Sprawdź poniższą tabelę dla GRDType |
color01 | String | #5e0bf0 | Kolor gradientu 1 wzorów qr |
color02 | String | #f30505 | Kolor gradientu 2 wzorów qr |
eye_color | Boolean | false | Ustaw „true”, aby zmienić kolor oczu |
eye_color01 | String | #5e0bf0 | Kolor oka zewnętrznego |
eye_color02 | String | #f30505 | Kolor oka wewnętrznego |
eye_outer | String | eyeOuter0 | Inna konstrukcja oka zewnętrznego, sprawdź poniższą tabelę dla wszystkich wzorów projektowych |
eye_inner | String | eyeInner0 | Inna konstrukcja wewnętrznego oka, sprawdź poniżej tabeli dla wszystkich wzorów projektowych |
qrData | String | pattern0 | Różne wzorce danych qr, sprawdź poniższą tabelę dla wszystkich wzorców projektowych |
qrFormat | String | png | Pobierz binarny typ pliku obrazu „png” lub „svg” |
transparentBkg | Boolean | false | Jeśli jest włączona, kod QR będzie miał przezroczyste tło |
frame | Number | null | Jeśli ta opcja jest włączona, QR będzie mieć ramkę. Sprawdź poniższą tabelę dla projektów ramek |
frameColor | String | null | Kolor ramki zmienia kolor tekstu ramki |
frameText | String | SCAN ME | Tekst ramki pokazany nad ramką QR |
Przykład
URL | /api/qr/static |
Metody | POST |
parametr | { "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" } |
Odpowiedź | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Pobierz listę wszystkich kampanii QR w różnych kategoriach QR
URL | /api/campaign/ |
Metody | GET |
Autoryzacja | Bearer API KEY |
Odpowiedź | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Parametry zapyt
parametr | Domyślne | Opis |
---|---|---|
page | 1 | liczba strony |
limit | 5 | liczba kampanii na stronie |
sort | 1 | Sortuj według daty (1) lub nazwy (2) |
category | url | kategoria zdefiniować inny typ qr jak url, Vcard, facebook, itp Sprawdź poniżej QRCategory tabeli. |
Przykład
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Metody | GET |
parametr | { "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" } |
Odpowiedź | { "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. Generowanie dynamicznego niestandardowego kodu Visual QR
URL | /api/campaign/ |
Metody | POST |
Autoryzacja | Bearer API KEY |
Odpowiedź | Binary Image File (PNG, SVG) |
Parametry zapyt
parametr | Typ | Domyślne | Opis | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Twój żądany adres URL przekierowania zostanie osadzony w QR | |
qrType | String | qr2 | QRType zdefiniować zachowanie qr jak pojedynczy przekierowanie url lub multi przekierowanie url („qr2” lub „murl”) | |
qrCategory | String | url | QRCategory zdefiniować inny typ qr jak url, Vcard, facebook, itp Sprawdź poniżej QRCategory tabeli. | |
qr: | JSON Object | Zaprojektuj swój kod qr jak kolor, wzory danych, oczy, itp w tym obiekcie | ||
size | Number | 500 | Rozmiar qr | |
logo | String (url) | null | Dodaj dowolny adres URL logo, aby włączyć logo w centrum QR | |
colorDark | String | #5e0bf0 | Kolor wzorów qr | |
backgroundColor | String | #ffffff | Kolor tła QR. (Uwaga: zawsze wybieraj jasny kolor, aby w pełni zeskanować QR) | |
gradient | Boolean | false | Ustaw „true”, aby włączyć kolor gradientu | |
grdType | Number | 0 (Left-to-Right) | Sprawdź poniższą tabelę dla GRDType | |
color01 | String | #5e0bf0 | Kolor gradientu 1 wzorów qr | |
color02 | String | #f30505 | Kolor gradientu 2 wzorów qr | |
eye_color | Boolean | false | Ustaw „true”, aby zmienić kolor oczu | |
eye_color01 | String | #5e0bf0 | Kolor oka zewnętrznego | |
eye_color02 | String | #f30505 | Kolor oka wewnętrznego | |
eye_outer | String | eyeOuter0 | Inna konstrukcja oka zewnętrznego, sprawdź poniższą tabelę dla wszystkich wzorów projektowych | |
eye_inner | String | eyeInner0 | Inna konstrukcja wewnętrznego oka, sprawdź poniżej tabeli dla wszystkich wzorów projektowych | |
qrData | String | pattern0 | Różne wzorce danych qr, sprawdź poniższą tabelę dla wszystkich wzorców projektowych | |
qrFormat | String | png | Pobierz binarny typ pliku obrazu „png” lub „svg” | |
transparentBkg | Boolean | false | Jeśli jest włączona, kod QR będzie miał przezroczyste tło | |
frame | Number | null | Jeśli ta opcja jest włączona, QR będzie mieć ramkę. Sprawdź poniższą tabelę dla projektów ramek | |
frameColor | String | null | Kolor ramki zmienia kolor tekstu ramki | |
frameText | String | SCAN ME | Tekst ramki pokazany nad ramką QR |
Przykład
URL | /api/campaign |
Metody | 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)
parametr | Typ | Wartość | Opis |
---|---|---|---|
Lewy - Prawy | String | linear | Przepływ gradientu od lewej do prawej |
Góra - Dół | String | upDown | Przepływ gradientu od góry do dołu |
NW - SE | String | diagonal1 | Przepływ gradientu po przekątnej w dół |
SW - NE | String | diagonal2 | Przepływ gradientowy po przekątnej w górę |
Radialne | String | radial | Przepływ gradientu promieniowo |
eye_outer (Default 0)
parametr | Typ | Wartość | Opis |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
parametr | Typ | Wartość | Opis |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
parametr | Typ | Wartość | Opis |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
parametr | Typ | Wartość | Opis |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Śledź swoje dane QR, Nie. Skany, Kraj, Miasto, Typ urządzenia
URL | /data/qrid?period=month&tz=Asia/Singapore |
Metody | GET |
Autoryzacja | Bearer API KEY |
Odpowiedź | JSON object of track data |
Parametr żądanie
parametr | Typ | Opis |
---|---|---|
qrId | params | Unikalny identyfikator qr |
period | query | „dzień” (dane z bieżącego dnia) „tydzień” (dane z bieżącego tygodnia) „miesiąc” (dane z bieżącego miesiąca) „miesiące” (dane z bieżącego roku) „rok” (Dane roczne) |
tz | query | Domyślna Azja/Singap |
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. Prześlij swoje logo
URL | /accounts/uploads/ |
Metody | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |