QR codes

Alle abrufen

Endpunkt

GET https://qrcodes.at/api/qr-codes/

Beispiel

curl --request GET \
--url 'https://qrcodes.at/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \

Parameter	Details	Beschreibung
page	Optional Ganzzahl	Die Seitennummer, von der Sie Ergebnisse möchten. Standard ist `1`.
results_per_page	Optional Ganzzahl	Wie viele Ergebnisse Sie pro Seite möchten. Erlaubte Werte sind: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standard ist `25`.

Antwortbeispiel

{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://qrcodes.at/uploads/qr_code/example.svg", "qr_code_logo": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://qrcodes.at/api/qr-codes?&page=1", "last": "https://qrcodes.at/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://qrcodes.at/api/qr-codes?&page=1" } }

Einen abrufen

Endpunkt

GET https://qrcodes.at/api/qr-codes/{qr_code_id}

Beispiel

curl --request GET \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

Antwortbeispiel

{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://qrcodes.at/uploads/qr_code/example.svg", "qr_code_logo": null, "settings": { "foreground_type": "color", "foreground_color": "#000000", "background_color": "#ffffff", "custom_eyes_color": false, "qr_code_logo_size": 25, "size": 500, "margin": 0, "ecc": "L", "url": "https://example.com" }, "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Erstellen

Endpunkt

POST https://qrcodes.at/api/qr-codes

Parameter	Details	Beschreibung
project_id	Optional Ganzzahl	-
name	Erforderlich Zeichenkette	-
type	Erforderlich Zeichenkette	Erlaubte Werte: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `crypto`, `vcard`, `paypal`
style	Optional Zeichenkette	Erlaubte Werte: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Optional Zeichenkette	Erlaubte Werte: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Optional Zeichenkette	Erlaubte Werte: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Optional Zeichenkette	Erlaubte Werte: `color`, `gradient`
foreground_color	Optional Zeichenkette	(foreground_type=color)
foreground_gradient_style	Optional Zeichenkette	Erlaubte Werte: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Optional Zeichenkette	(foreground_type=gradient)
foreground_gradient_two	Optional Zeichenkette	(foreground_type=gradient)
background_color	Optional Zeichenkette
background_color_transparency	Optional Ganzzahl
custom_eyes_color	Optional Boolescher Wert
eyes_inner_color	Optional Zeichenkette	(custom_eyes_color=1)
eyes_outer_color	Optional Zeichenkette	(custom_eyes_color=1)
qr_code_logo	Optional Datei	-
qr_code_logo_size	Optional Ganzzahl	5-35
size	Optional Ganzzahl	50-2000
margin	Optional Ganzzahl	0-25
ecc	Optional Zeichenkette	Erlaubte Werte: `L`, `M`, `Q`, `H`
text	Optional Zeichenkette	(type=text)
url	Optional Zeichenkette	(type=url)
phone	Optional Zeichenkette	(type=phone)
sms	Optional Zeichenkette	(type=sms)
sms_body	Optional Zeichenkette	(type=sms)
email	Optional Zeichenkette	(type=email)
email_subject	Optional Zeichenkette	(type=email)
email_body	Optional Zeichenkette	(type=email)
whatsapp	Optional Zeichenkette	(type=whatsapp)
whatsapp_body	Optional Zeichenkette	(type=whatsapp)
facetime	Optional Zeichenkette	(type=facetime)
location_latitude	Optional Fließkommazahl	(type=location)
location_longitude	Optional Fließkommazahl	(type=location)
wifi_ssid	Optional Zeichenkette	(type=wifi)
wifi_encryption	Optional Zeichenkette	Erlaubte Werte: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	Optional Zeichenkette	(type=wifi)
wifi_is_hidden	Optional Boolescher Wert	(type=wifi)
event	Optional Zeichenkette	(type=event)
event_location	Optional Zeichenkette	(type=event)
event_url	Optional Zeichenkette	(type=event)
event_note	Optional Zeichenkette	(type=event)
event_timezone	Optional Zeichenkette	(type=event)
event_start_datetime	Optional Zeichenkette	(type=event)
event_end_datetime	Optional Zeichenkette	(type=event)
crypto_coin	Optional Zeichenkette	(type=crypto)
crypto_address	Optional Zeichenkette	(type=crypto)
crypto_amount	Optional Zeichenkette	(type=crypto)
vcard_first_name	Optional Zeichenkette	(type=vcard)
vcard_last_name	Optional Zeichenkette	(type=vcard)
vcard_company	Optional Zeichenkette	(type=vcard)
vcard_phone_numbers	Optional Array Zeichenkette	(type=vcard)
vcard_email	Optional Zeichenkette	(type=vcard)
vcard_url	Optional Zeichenkette	(type=vcard)
vcard_job_title	Optional Zeichenkette	(type=vcard)
vcard_birthday	Optional Zeichenkette	(type=vcard)
vcard_street	Optional Zeichenkette	(type=vcard)
vcard_city	Optional Zeichenkette	(type=vcard)
vcard_zip	Optional Zeichenkette	(type=vcard)
vcard_region	Optional Zeichenkette	(type=vcard)
vcard_country	Optional Zeichenkette	(type=vcard)
vcard_note	Optional Zeichenkette	(type=vcard)
vcard_social_label[index]	Optional Zeichenkette	(type=vcard)
vcard_social_value[index]	Optional Zeichenkette	(type=vcard)
paypal_type	Optional Zeichenkette	Erlaubte Werte: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	Optional Zeichenkette	(type=paypal)
paypal_title	Optional Zeichenkette	(type=paypal)
paypal_currency	Optional Zeichenkette	(type=paypal)
paypal_price	Optional Fließkommazahl	(type=paypal)
paypal_thank_you_url	Optional Zeichenkette	(type=paypal)
paypal_cancel_url	Optional Zeichenkette	(type=paypal)

Beispiel

curl --request POST \
--url 'https://qrcodes.at/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

Antwortbeispiel

{ "data": { "id": 1 } }

Aktualisieren

Endpunkt

POST https://qrcodes.at/api/qr-codes/{qr_code_id}

Parameter	Details	Beschreibung
project_id	Optional Zeichenkette	-
name	Optional Zeichenkette	-
type	Optional Zeichenkette	Erlaubte Werte: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `crypto`, `vcard`, `paypal`
style	Optional Zeichenkette	Erlaubte Werte: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Optional Zeichenkette	Erlaubte Werte: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Optional Zeichenkette	Erlaubte Werte: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Optional Zeichenkette	Erlaubte Werte: `color`, `gradient`
foreground_color	Optional Zeichenkette	(foreground_type=color)
foreground_gradient_style	Optional Zeichenkette	Erlaubte Werte: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Optional Zeichenkette	(foreground_type=gradient)
foreground_gradient_two	Optional Zeichenkette	(foreground_type=gradient)
background_color	Optional Zeichenkette
background_color_transparency	Optional Ganzzahl
custom_eyes_color	Optional Boolescher Wert
eyes_inner_color	Optional Zeichenkette	(custom_eyes_color=1)
eyes_outer_color	Optional Zeichenkette	(custom_eyes_color=1)
qr_code_logo	Optional Datei	-
qr_code_logo_size	Optional Ganzzahl	5-35
size	Optional Ganzzahl	50-2000
margin	Optional Ganzzahl	0-25
ecc	Optional Zeichenkette	Erlaubte Werte: `L`, `M`, `Q`, `H`
text	Optional Zeichenkette	(type=text)
url	Optional Zeichenkette	(type=url)
phone	Optional Zeichenkette	(type=phone)
sms	Optional Zeichenkette	(type=sms)
sms_body	Optional Zeichenkette	(type=sms)
email	Optional Zeichenkette	(type=email)
email_subject	Optional Zeichenkette	(type=email)
email_body	Optional Zeichenkette	(type=email)
whatsapp	Optional Zeichenkette	(type=whatsapp)
whatsapp_body	Optional Zeichenkette	(type=whatsapp)
facetime	Optional Zeichenkette	(type=facetime)
location_latitude	Optional Fließkommazahl	(type=location)
location_longitude	Optional Fließkommazahl	(type=location)
wifi_ssid	Optional Zeichenkette	(type=wifi)
wifi_encryption	Optional Zeichenkette	Erlaubte Werte: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	Optional Zeichenkette	(type=wifi)
wifi_is_hidden	Optional Boolescher Wert	(type=wifi)
event	Optional Zeichenkette	(type=event)
event_location	Optional Zeichenkette	(type=event)
event_url	Optional Zeichenkette	(type=event)
event_note	Optional Zeichenkette	(type=event)
event_timezone	Optional Zeichenkette	(type=event)
event_start_datetime	Optional Zeichenkette	(type=event)
event_end_datetime	Optional Zeichenkette	(type=event)
crypto_coin	Optional Zeichenkette	(type=crypto)
crypto_address	Optional Zeichenkette	(type=crypto)
crypto_amount	Optional Zeichenkette	(type=crypto)
vcard_first_name	Optional Zeichenkette	(type=vcard)
vcard_last_name	Optional Zeichenkette	(type=vcard)
vcard_company	Optional Zeichenkette	(type=vcard)
vcard_phone_numbers	Optional Array Zeichenkette	(type=vcard)
vcard_email	Optional Zeichenkette	(type=vcard)
vcard_url	Optional Zeichenkette	(type=vcard)
vcard_job_title	Optional Zeichenkette	(type=vcard)
vcard_birthday	Optional Zeichenkette	(type=vcard)
vcard_street	Optional Zeichenkette	(type=vcard)
vcard_city	Optional Zeichenkette	(type=vcard)
vcard_zip	Optional Zeichenkette	(type=vcard)
vcard_region	Optional Zeichenkette	(type=vcard)
vcard_country	Optional Zeichenkette	(type=vcard)
vcard_note	Optional Zeichenkette	(type=vcard)
vcard_social_label[index]	Optional Zeichenkette	(type=vcard)
vcard_social_value[index]	Optional Zeichenkette	(type=vcard)
paypal_type	Optional Zeichenkette	Erlaubte Werte: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	Optional Zeichenkette	(type=paypal)
paypal_title	Optional Zeichenkette	(type=paypal)
paypal_currency	Optional Zeichenkette	(type=paypal)
paypal_price	Optional Fließkommazahl	(type=paypal)
paypal_thank_you_url	Optional Zeichenkette	(type=paypal)
paypal_cancel_url	Optional Zeichenkette	(type=paypal)

Beispiel

curl --request POST \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Antwortbeispiel

{ "data": { "id": 1 } }

Löschen

Endpunkt

DELETE https://qrcodes.at/api/qr-codes/{qr_code_id}

Beispiel

curl --request DELETE \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \