Forritari QR Code API Leiðarvísir
QR Code API gerir notendum kleift að búa til hágæða QR kóða á forritanlegan hátt eða samþætta mikla fjölda hraðra QR kóða. Það veitir einfaldan og árangursríkan hátt til að búa til QR kóða fyrir ýmsa notkunartilfelli, svo sem sjálfvirkar greiðslur, samþættingu í forrit, vörumerkingar og fleira. API-ið styður mismunandi aðlögunarvalkosti, þar á meðal stærð, lit, lögun, landamæri, tegund o.s.frv. Forritarar geta samþætt það í forrit sín með því að senda HTTP beiðnir og veita API lykil til staðfestingar, eða með því að nota okkar bókasagnir.
API Lykill
API lykillinn fyrir reikninginn þinn getur verið búinn til á reikningasíðunni. API lykillinn getur verið innifalinn í beiðnum annað hvort sem URL breyta, til dæmis: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY, eða í `GenQRCode-apikey` fyrirsagnanum. Fyrir restina af þessum leiðarvísir, munum við gera ráð fyrir notkun fyrirsagnans, þar sem þetta er öruggari kostur, en báðir valkostirnir geta verið notaðir saman. API lykillinn ætti að vera meðhöndlaður sem leynivalkostur og þú ættir ekki að deila honum með öðrum.
Takmörkun á beiðnum
Takmörkun á beiðnum er framfylgt til að tryggja sanngjarna notkun API-ið. Frítt stig inniheldur 180 tokens á klukkustund. Venjulegir QR kóðar kosta 1 token hver, með hámarki á 180 tokens á klukkustund, sem jafngildir 1 QR kóða á 20 sekúndna fresti. Að auki munu hraðari kallpunktar kosta 1/50 af tokeni, sem jafngildir 2.5 QR kóðum á sekúndu. Þessir hraðari kallpunktar eru mælt með þegar engin aðlögun á QR kóðanum er krafist. Ef token takmörkin eru farið yfir, mun staðfestingarkóði 429 verða skilað, sem vísar til þess að beiðnin hefur verið takmörkuð.
Notkun á mörgum reikningum til að komast undan þessum takmörkunum er bannað. Ef hærri takmörk eru nauðsynleg, vinsamlegast hafðu samband við okkur fyrir verðlagningu.
Bókasagnir
Stöðugur QR Code API
QR Code tegundir
QR Code tegundin er grundvöllur hvers QR kóða. Hún ákvarðar hvernig gögnin eru kóðuð og hvernig QR kóðinn hegðar sér þegar hann er skannaður. Að velja rétta tegund er mikilvægt, þar sem það hefur áhrif á virkni QR kóðans. Hér að neðan eru allar tiltækar tegundir til að velja úr.
Text
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 0 For a Text QR Code |
text | String | false | Textinn inni í QR kóðanum. |
WiFi
Parameter | Tegund | Valskyldur | Lýsing | ||||||
---|---|---|---|---|---|---|---|---|---|
type | Int | false | Use 1 For a WiFi QR Code | ||||||
network | String | false | Wi-Fi netfangið. | ||||||
password | String | true | Wi-Fi lykilorð. | ||||||
hidden | String | true | Hvort Wi-Fi netið sé falin. | ||||||
encryption | String | true |
Dulkóðun sem notuð er fyrir Wi-Fi netið.
Mögulegir gildi
|
SMS
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 2 For a SMS QR Code |
text | String | false | Textaskilaboð. |
number | String | false | Símanúmer. |
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 3 For a Email QR Code |
String | true | Tölvupóstfang í "Til" reitnum. | |
subject | String | true | Viðfangsefni tölvupóstsins. |
message | String | true | Skilaboð tölvupóstsins. |
Phone
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 4 For a Phone QR Code |
number | String | false | Símanúmer. |
Crypto
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 5 For a Crypto QR Code |
cryptotype | String | false | Tegund dulkóðunar sem á að senda. |
address | String | false | Dulkóðunarskírteini fyrir viðtakanda. |
amount | String | true | Upphæð dulkóðunar sem á að senda. |
vCard
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 6 For a vCard QR Code |
vc_first_name | String | false | Fyrsta nafn vCard. |
vc_last_name | String | false | Eftirnafn vCard. |
vc_company | String | true | Fyrirtækið. |
vc_job | String | true | Starf. |
vc_street | String | true | Gata. |
vc_city | String | true | Borg. |
vc_state | String | true | Fylki. |
vc_zip | String | true | Póstnúmer. |
vc_country | String | true | Land. |
vc_phone | String | true | Símanúmer. |
vc_mobile | String | true | Mobil símanúmer. |
vc_fax | String | true | Faxi símanúmer. |
vc_website | String | true | Vefsíðu slóð. |
vc_email | String | true | Tölvupóstfang. |
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 7 For a Whatsapp QR Code |
number | String | false | Símanúmer. |
text | String | true | Whatsapp textaskilaboð. |
vEvent
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 8 For a vEvent QR Code |
ve_summary | String | true | Yfirlit vEvent. |
ve_description | String | true | Lýsing vEvent. |
ve_location | String | true | Staðsetning vEvent. |
ve_timezone | String | true | Tímabelti byrjunartíma og lokatíma vEvent. |
ve_url | String | true | URL vEvent. |
ve_start | String | true | Byrjunartími vEvent. |
ve_end | String | true | Lokunartími vEvent. |
Geo
Parameter | Tegund | Valskyldur | Lýsing |
---|---|---|---|
type | Int | false | Use 9 For a Geo QR Code |
ge_latitude | String | false | Breiddargráða til að kóða. |
ge_longitude | String | false | Lengdargráða til að kóða. |
Dæmi um texta QR Code
URL | https://api.genqrcode.com/public/generate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "type": 0, "text": "https://genqrcode.com" } |
Svar | ![]() |
Dæmi um Wi-Fi QR Code
URL | https://api.genqrcode.com/public/generate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" } |
Svar | ![]() |
Almenni parámetrar
Hér eru allir aðlöganlegu almennu parámetrarnir útskýrðir og hvernig á að nota þá.
Parameter | Tegund | Sjálfgefið gildi | Lýsing | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
imageformat | String | png |
Myndavísun á QR kóða.
Mögulegir gildi
|
||||||||||||||||||||
bordersize | Int | 4 | Mörk á kringum QR kóðann. | ||||||||||||||||||||
width | Int | 500 | Breidd QR kóðans. Hámarksstærð 2000. | ||||||||||||||||||||
height | Int | 500 | Hæð QR kóðans. Hámarksstærð 2000. |
Litir parameterar
Hér eru allir aðlöganlegu litir parameterar útskýrðir og hvernig á að nota þá.
Parameter | Tegund | Sjálfgefið gildi | Lýsing |
---|---|---|---|
color | String | #000000 | Litur QR kóðans. Formatið á að vera annað hvort #RRGGBB eða #RRGGBBAA. |
custom_color_pattern | String | 1 | Myndmynstur litanna. Til dæmis, ef litirnir eru #ff0000, #00ff00 og #0000ff, og mynstur er 1,2,3,3,2,1, þá mun litamynstrið skipta um lit í samræmi við þetta mynstur. |
background_color | String | #FFFFFF | Bakgrunnslitur QR kóðans. Til að gera bakgrunninn gegnsæjan, stilltu alpha gildi á 00. |
inner_eye_color | String | #000000 | Litur innri auga QR kóðans. |
outer_eye_color | String | #000000 | Litur ytri auga QR kóðans. |
frame_color | String | #000000 | Litur rammsins umhverfis QR kóðann. Rammi þarf að vera stilltur fyrir þetta til að hafa áhrif. |
Dæmi um litinn QR Code
URL | https://api.genqrcode.com/public/generate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" } |
Svar | ![]() |
Dæmi um litamynstur QR Code
URL | https://api.genqrcode.com/public/generate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" } |
Svar | ![]() |
Rammi, Lögun og Logo parameterar
Hér eru allir aðlöganlegu rammi, lögun og logo parameterar útskýrðir og hvernig á að nota þá.
Parameter | Tegund | Sjálfgefið gildi | Lýsing |
---|---|---|---|
style | Int | 0 |
Stíll ferla QR kóðans.
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
inner_eye_style | Int | 0 |
Stíll innri auga QR kóðans.
0
1
2
3
4
5
6
7
|
outer_eye_style | Int | 0 |
Stíll ytri auga QR kóðans.
0
1
2
3
4
5
6
|
frame_style | Int | 0 |
Stíll rammsins umhverfis QR kóðann.
0
1
2
3
4
5
6
7
8
9
10
11
12
13
|
frame_text | String | SCAN ME | Textinn inni í ramma. Rammi með texta þarf að vera stilltur áður en hann verður sýnilegur. |
logo | String |
Merki sem á að nota innan QR kóðans.
youtube
![]()
wifi
![]()
google-maps
![]()
facebook
![]()
spotify
![]()
threads
![]()
zoom
![]()
instagram
![]()
linkedin
![]()
genqrcode
![]()
google-drive
![]()
airbnb
![]()
skype
![]()
snapchat
![]()
twitter
![]()
x-twitter
![]()
reddit
![]() |
|
logo_remove_background | Boolean | false | Hvort bakgrunnur fyrir merki eigi að fjarlægja. |
Dæmi um logo og lögun QR Code
URL | https://api.genqrcode.com/public/generate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true } |
Svar | ![]() |
Dæmi um sérsniðið logo
Til að nota sérsniðið logo þurfum við að hlaða upp logo okkar með multipart form data beiðni. Útkoman getur verið notuð í logo reitinn.
URL | https://api.genqrcode.com/public/upload/logo |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY Content-Type: multipart/form-data |
Svar | 586d0136af8a06e4a2b50cf9f2af0b72 |
Hraði QR Code API
Hraði QR Code API kostar aðeins 1/50 tokens af venjulegu API. QR kóðarnir eru hannaðir fyrir hraða og minni niðurhalsstærð. Þó að það styðji allar QR kóða tegundir, styður það aðeins nokkra aðlögunarparametera.
Hraði QR Code Parameterar
Hér eru allir hraðari QR Code parameterar útskýrðir og hvernig á að nota þá.
Parameter | Tegund | Sjálfgefið gildi | Lýsing | ||||
---|---|---|---|---|---|---|---|
imageformat | String | png |
Myndavísun á QR kóða.
Mögulegir gildi
|
||||
bordersize | Int | 4 | Mörk á kringum QR kóðann. | ||||
width | Int | 500 | Breidd QR kóðans. Það mun sjálfkrafa endurmælast á næstu stilltu stærð til að koma í veg fyrir neina útvíkkanir. Hámarksstærð 4000. | ||||
height | Int | 500 | Hæð QR kóðans. Það mun sjálfkrafa endurmælast á næstu stilltu stærð til að koma í veg fyrir neina útvíkkanir. Hámarksstærð 4000. |
Dæmi um hraða texta QR Code
URL | https://api.genqrcode.com/public/fastgenerate |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "imageformat": "png", "type": 0, "text": "https://genqrcode.com" } |
Svar | ![]() |
Hraðbatch QR Code API
Dæmi um hraðbatch texta QR Code
URL | https://api.genqrcode.com/public/fastbatch |
---|---|
Beiðnismáti | POST |
Fyrirsagnir | GenQRCode-apikey: API_KEY |
Líkami | { "QR Code 1": { "text": "https://genqrcode.com", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 }, "QR Code 2": { "text": "https://genqrcode.com/dynamicview", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 }, "QR Code 3": { "text": "https://genqrcode.com/pricing", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 } } |
Svar | QR Codes in a zip file. |