Kody QR

Twórz kody QR z logo, kolorami, stylami i typami treści, a następnie listuj je lub aktualizuj.

Obsługiwane typy

Przekaż type jako jeden z tych kluczy. Pola treści zmieniają się wraz z typem.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

Utwórz kod QR

Wyślij JSON w ciele żądania. name i type są wymagane. Dla typów url podaj url. Dodaj style, kolory i qr_code_logo, aby odwzorować kod ze studia. Typ file nie jest dostępny w API.

Nazwa	Typ	Wymagane	Domyślnie	Opis
name	string	Tak	—	Etykieta zapisana na zasobie.
type	string	Tak	url	Typ treści. Jeden z obsługiwanych kluczy QR, z wyjątkiem file.
url	string	Nie	—	Docelowy URL. Wymagany, gdy type to url.
text	string	Nie	—	Zwykły tekst. Wymagany, gdy type to text. Przy tekście masowym oddziel wiersze w tym polu.
url_dynamic	boolean	Nie	false	Jeśli true, tworzony jest krótki link, a QR koduje ten link, aby cel można było później zmienić.
project_id	integer	Nie	—	Projekt, do którego dołączyć zasób.
is_bulk	boolean	Nie	false	Jeśli true i type to text, powstaje jeden QR na każdy wiersz w text.
style	string	Nie	square	Kształt modułu. Przykłady: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nie	square	Kształt wewnętrznego wzoru wyszukiwania. Przykłady: square, dot, circle, rounded.
outer_eye_style	string	Nie	square	Kształt zewnętrznego wzoru wyszukiwania. Przykłady: square, circle, rounded, flower.
size	integer	Nie	500	Rozmiar obrazu w pikselach, 50–2000.
margin	integer	Nie	0	Moduły strefy ciszy, 0–25.
ecc	string	Nie	M	Korekcja błędów: L, M, Q lub H. Użyj H, gdy dodajesz logo.
foreground_type	string	Nie	color	color lub gradient.
foreground_color	string	Nie	#000000	Kolor modułów jako HEX.
foreground_gradient_style	string	Nie	horizontal	vertical, horizontal, diagonal, inverse_diagonal lub radial.
foreground_gradient_one	string	Nie	—	Pierwszy kolor HEX gradientu.
foreground_gradient_two	string	Nie	—	Drugi kolor HEX gradientu.
background_color	string	Nie	#ffffff	Kolor HEX tła. Utrzymuj jaśniejszy niż moduły.
background_color_transparency	integer	Nie	0	Przezroczystość tła, 0–100.
custom_eyes_color	boolean	Nie	false	Jeśli true, oczy używają eyes_inner_color i eyes_outer_color.
eyes_inner_color	string	Nie	#000000	Kolor HEX wewnętrznego oka.
eyes_outer_color	string	Nie	#000000	Kolor HEX zewnętrznego oka.
qr_code_logo	string	Nie	—	URL obrazu logo lub klucz przesłanego pliku.
qr_code_logo_size	number	Nie	25	Rozmiar logo jako procent QR, 5–40.
frame	string	Nie	—	Opcjonalny klucz ramki ze studia.
frame_text	string	Nie	—	Podpis narysowany na ramce.

Pola treści według typu

Nazwa	Typ	Wymagane	Domyślnie	Opis
phone	string	Nie	—	Numer telefonu, gdy type to phone.
sms	string	Nie	—	Numer telefonu, gdy type to sms.
sms_body	string	Nie	—	Treść wiadomości SMS.
email	string	Nie	—	Odbiorca, gdy type to email.
email_subject	string	Nie	—	Temat e-maila.
email_body	string	Nie	—	Treść e-maila.
whatsapp	string	Nie	—	Numer WhatsApp, tylko cyfry.
whatsapp_body	string	Nie	—	Wstępnie wypełniony tekst WhatsApp.
wifi_ssid	string	Nie	—	Nazwa sieci, gdy type to wifi.
wifi_password	string	Nie	—	Hasło Wi-Fi.
wifi_encryption	string	Nie	WPA	nopass, WEP, WPA lub WPA/WPA2.
location_latitude	number	Nie	—	Szerokość geograficzna, gdy type to location.
location_longitude	number	Nie	—	Długość geograficzna, gdy type to location.
event	string	Nie	—	Tytuł wydarzenia, gdy type to event.
event_start_datetime	string	Nie	—	Data-czas ISO rozpoczęcia wydarzenia.
vcard first_name / last_name / email	string	Nie	—	Pola vCard: first_name, last_name, email i pozostałe klucze studia.

Przykład żądania

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

Więcej przykładów

QR z gradientem

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

QR Wi-Fi

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

Przykład odpowiedzi

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

Lista kod QR

Nazwa	Typ	Wymagane	Opis
page	integer	Nie	Page number (default 1)
results_per_page	integer	Nie	Items per page (default 25, max 100)
search	string	Nie	Search term
search_by	string	Nie	Column to search
order_by	string	Nie	Sort column
order_type	string	Nie	asc or desc
datetime_start	string	Nie	ISO datetime filter start
datetime_end	string	Nie	ISO datetime filter end
project_id	integer	Nie	—
type	string	Nie	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

Odczytaj jeden kod QR

Nazwa	Typ	Wymagane	Opis
id	integer	Tak	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

Aktualizuj kod QR

Nazwa	Typ	Wymagane	Domyślnie	Opis
id	integer	Tak	—	—
name	string	Nie	—	Etykieta zapisana na zasobie.
type	string	Nie	url	Typ treści. Jeden z obsługiwanych kluczy QR, z wyjątkiem file.
url	string	Nie	—	Docelowy URL. Wymagany, gdy type to url.
text	string	Nie	—	Zwykły tekst. Wymagany, gdy type to text. Przy tekście masowym oddziel wiersze w tym polu.
url_dynamic	boolean	Nie	false	Jeśli true, tworzony jest krótki link, a QR koduje ten link, aby cel można było później zmienić.
project_id	integer	Nie	—	Projekt, do którego dołączyć zasób.
is_bulk	boolean	Nie	false	Jeśli true i type to text, powstaje jeden QR na każdy wiersz w text.
style	string	Nie	square	Kształt modułu. Przykłady: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nie	square	Kształt wewnętrznego wzoru wyszukiwania. Przykłady: square, dot, circle, rounded.
outer_eye_style	string	Nie	square	Kształt zewnętrznego wzoru wyszukiwania. Przykłady: square, circle, rounded, flower.
size	integer	Nie	500	Rozmiar obrazu w pikselach, 50–2000.
margin	integer	Nie	0	Moduły strefy ciszy, 0–25.
ecc	string	Nie	M	Korekcja błędów: L, M, Q lub H. Użyj H, gdy dodajesz logo.
foreground_type	string	Nie	color	color lub gradient.
foreground_color	string	Nie	#000000	Kolor modułów jako HEX.
foreground_gradient_style	string	Nie	horizontal	vertical, horizontal, diagonal, inverse_diagonal lub radial.
foreground_gradient_one	string	Nie	—	Pierwszy kolor HEX gradientu.
foreground_gradient_two	string	Nie	—	Drugi kolor HEX gradientu.
background_color	string	Nie	#ffffff	Kolor HEX tła. Utrzymuj jaśniejszy niż moduły.
background_color_transparency	integer	Nie	0	Przezroczystość tła, 0–100.
custom_eyes_color	boolean	Nie	false	Jeśli true, oczy używają eyes_inner_color i eyes_outer_color.
eyes_inner_color	string	Nie	#000000	Kolor HEX wewnętrznego oka.
eyes_outer_color	string	Nie	#000000	Kolor HEX zewnętrznego oka.
qr_code_logo	string	Nie	—	URL obrazu logo lub klucz przesłanego pliku.
qr_code_logo_size	number	Nie	25	Rozmiar logo jako procent QR, 5–40.
frame	string	Nie	—	Opcjonalny klucz ramki ze studia.
frame_text	string	Nie	—	Podpis narysowany na ramce.

Przykład żądania

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

Usuń kod QR

Nazwa	Typ	Wymagane	Opis
id	integer	Tak	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Nazwy parametrów i przykłady JSON są po angielsku. Zamień YOUR_API_KEY na klucz konta.