Przewodnik po API kodów QR dla deweloperów

Klucz API

Klucz API dla Twojego konta można utworzyć na stronie konta. Klucz API może być dołączony do żądań jako parametr URL, na przykład: https://api.genqrcode.com/public/generate?apikey=YOUR_API_KEY, lub w nagłówku `GenQRCode-apikey`. W dalszej części tego przewodnika zakładamy użycie nagłówka, ponieważ jest to bezpieczniejsza opcja, ale obie metody mogą być stosowane zamiennie. Klucz API powinien być traktowany jako tajny i nie powinien być udostępniany nikomu.

Ograniczenie liczby żądań

Ograniczenie liczby żądań jest stosowane w celu zapewnienia uczciwego korzystania z API. Darmowy plan obejmuje 180 tokenów na godzinę. Standardowe kody QR kosztują 1 token każdy, z maksymalnym limitem 180 tokenów na godzinę, co odpowiada 1 kodowi QR co 20 sekund. Dodatkowo, szybkie punkty końcowe zużywają 1/50 tokena, co odpowiada 2,5 kodu QR na sekundę. Te szybkie punkty końcowe są zalecane, gdy nie jest wymagana personalizacja kodu QR. Jeśli limit tokenów zostanie przekroczony, zwrócony zostanie kod statusu 429, informujący o ograniczeniu liczby żądań.

Korzystanie z wielu kont w celu obejścia tych ograniczeń jest zabronione. Jeśli potrzebujesz wyższych limitów, skontaktuj się z nami w sprawie cennika.

Biblioteki

Java Library

API statycznych kodów QR

Przykładowy kod QR z tekstem

URL	https://api.genqrcode.com/public/generate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "type": 0, "text": "https://genqrcode.com" }
Odpowiedź

Przykładowy kod QR Wi-Fi

URL	https://api.genqrcode.com/public/generate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Odpowiedź

Przykładowy kod QR z kolorem

URL	https://api.genqrcode.com/public/generate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Odpowiedź

Przykładowy kod QR ze wzorem kolorystycznym

URL	https://api.genqrcode.com/public/generate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "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" }
Odpowiedź

Parametry ramki, kształtu i logo

Oto wszystkie konfigurowalne parametry ramki, kształtu i logo wraz z opisem ich użycia.

Parametr	Typ	Wartość domyślna	Opis
style	Int	0	Styl kwadratów kodu QR. 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	Styl wewnętrznych oczu kodu QR. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Styl zewnętrznych oczu kodu QR. 0 1 2 3 4 5 6
frame_style	Int	0	Styl ramki wokół kodu QR. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
frame_text	String	SCAN ME	Tekst wewnątrz ramki. Aby to było widoczne, musi być skonfigurowana ramka z tekstem.
logo	String		Logo do użycia wewnątrz kodu QR. 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	Czy usunąć tło za logo.

Przykładowy kod QR z logo i kształtem

URL	https://api.genqrcode.com/public/generate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "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 }
Odpowiedź

API szybkich kodów QR

API szybkich kodów QR kosztuje jedynie 1/50 tokena standardowego API. Kody QR są zoptymalizowane pod kątem szybkości i rozmiaru pobierania. Chociaż obsługuje wszystkie typy kodów QR, wspiera jedynie kilka parametrów dostosowywania.

Przykładowy szybki kod QR z tekstem

URL	https://api.genqrcode.com/public/fastgenerate
Metoda żądania	POST
Nagłówki	GenQRCode-apikey: API_KEY
Treść żądania	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Odpowiedź

API szybkiej partii kodów QR

{
  "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
  }
}