QR-koder - API Dokumentation

Hent alle

Slutpunkt

GET https://qr-kode.no/api/qr-codes/

Eksempel

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

Parametre	Detaljer	Beskrivelse
page	Valgfri Heltal	Sidenummeret, som du ønsker resultater fra. Standard er `1`
results_per_page	Valgfri Heltal	Hvor mange resultater ønsker du per side. Tilladte værdier er: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standard er `25`.

Respons eksempel

{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://qr-kode.no/uploads/qr_code/example.svg", "qr_code_logo": null, "qr_code_background": 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" ... }, "embedded_data": "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://qr-kode.no/api/qr-codes?&page=1", "last": "https://qr-kode.no/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://qr-kode.no/api/qr-codes?&page=1" } }

Hent en

Slutpunkt

GET https://qr-kode.no/api/qr-codes/{qr_code_id}

Eksempel

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

Respons eksempel

{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://qr-kode.no/uploads/qr_code/example.svg", "qr_code_logo": null, "qr_code_background": 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" ... }, "embedded_data": "https://example.com", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Opret

Slutpunkt

POST https://qr-kode.no/api/qr-codes

Parametre	Detaljer	Beskrivelse
project_id	Valgfri Heltal	-
name	Krævet Streng	-
type	Krævet Streng	Tilladte værdier: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`, `pix`
is_bulk	Valgfri Boolean	Available when: type = text
style	Valgfri Streng	Tilladte værdier: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Valgfri Streng	Tilladte værdier: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Valgfri Streng	Tilladte værdier: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Valgfri Streng	Tilladte værdier: `color`, `gradient`
foreground_color	Valgfri Streng	Available when: foreground_type = color
foreground_gradient_style	Valgfri Streng	Tilladte værdier: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Valgfri Streng	Available when: foreground_type = gradient
foreground_gradient_two	Valgfri Streng	Available when: foreground_type = gradient
background_color	Valgfri Streng
background_color_transparency	Valgfri Heltal
custom_eyes_color	Valgfri Boolean
eyes_inner_color	Valgfri Streng	Available when: custom_eyes_color = 1
eyes_outer_color	Valgfri Streng	Available when: custom_eyes_color = 1
qr_code_logo	Valgfri Fil	-
qr_code_logo_size	Valgfri Heltal	5-35
qr_code_background	Valgfri Fil	-
qr_code_background_transparency	Valgfri Heltal	0-100
qr_code_foreground	Valgfri Fil	-
qr_code_foreground_transparency	Valgfri Heltal	0-100
frame	Valgfri Streng	Tilladte værdier: `round_bottom_text`, `round_top_text`, `tooltip_bottom_text`, `tooltip_top_text`, `ribbon_bottom_text`, `ribbon_top_text`, `tooltip_snap_top_text`, `tooltip_snap_bottom_text`
frame_text	Valgfri Streng
frame_text_size	Valgfri Heltal	-5 - 5
frame_text_font	Valgfri Streng	Tilladte værdier: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	Valgfri Boolean
frame_color	Valgfri Streng	Available when: frame_custom_colors = 1
frame_text_color	Valgfri Streng	Available when: frame_custom_colors = 1
size	Valgfri Heltal	50-2000
margin	Valgfri Heltal	0-25
ecc	Valgfri Streng	Tilladte værdier: `L`, `M`, `Q`, `H`
text	Valgfri Streng	Available when: type = text
url	Valgfri Streng	Available when: type = url
phone	Valgfri Streng	Available when: type = phone
sms	Valgfri Streng	Available when: type = sms
sms_body	Valgfri Streng	Available when: type = sms
email	Valgfri Streng	Available when: type = email
email_subject	Valgfri Streng	Available when: type = email
email_body	Valgfri Streng	Available when: type = email
whatsapp	Valgfri Streng	Available when: type = whatsapp
whatsapp_body	Valgfri Streng	Available when: type = whatsapp
facetime	Valgfri Streng	Available when: type = facetime
location
location_latitude	Valgfri Flyd	Available when: type = location
location_longitude	Valgfri Flyd	Available when: type = location
wifi
wifi_ssid	Valgfri Streng	Available when: type = wifi
wifi_encryption	Valgfri Streng	Tilladte værdier: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	Valgfri Streng	Available when: type = wifi
wifi_is_hidden	Valgfri Boolean	Available when: type = wifi
event	Valgfri Streng	Available when: type = event
event_location	Valgfri Streng	Available when: type = event
event_url	Valgfri Streng	Available when: type = event
event_note	Valgfri Streng	Available when: type = event
event_timezone	Valgfri Streng	Available when: type = event
event_start_datetime	Valgfri Streng	Available when: type = event
event_end_datetime	Valgfri Streng	Available when: type = event
event_first_alert_datetime	Valgfri Streng	Available when: type = event
event_second_alert_datetime	Valgfri Streng	Available when: type = event
crypto
crypto_coin	Valgfri Streng	Available when: type = crypto
crypto_address	Valgfri Streng	Available when: type = crypto
crypto_amount	Valgfri Streng	Available when: type = crypto
vcard
vcard_first_name	Valgfri Streng	Available when: type = vcard
vcard_last_name	Valgfri Streng	Available when: type = vcard
vcard_company	Valgfri Streng	Available when: type = vcard
vcard_phone_number_label[index]	Valgfri Streng	Available when: type = vcard
vcard_phone_number_value[index]	Valgfri Streng	Available when: type = vcard
vcard_email	Valgfri Streng	Available when: type = vcard
vcard_url	Valgfri Streng	Available when: type = vcard
vcard_job_title	Valgfri Streng	Available when: type = vcard
vcard_birthday	Valgfri Streng	Available when: type = vcard
vcard_street	Valgfri Streng	Available when: type = vcard
vcard_city	Valgfri Streng	Available when: type = vcard
vcard_zip	Valgfri Streng	Available when: type = vcard
vcard_region	Valgfri Streng	Available when: type = vcard
vcard_country	Valgfri Streng	Available when: type = vcard
vcard_note	Valgfri Streng	Available when: type = vcard
vcard_social_label[index]	Valgfri Streng	Available when: type = vcard
vcard_social_value[index]	Valgfri Streng	Available when: type = vcard
paypal
paypal_type	Valgfri Streng	Tilladte værdier: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	Valgfri Streng	Available when: type = paypal
paypal_title	Valgfri Streng	Available when: type = paypal
paypal_currency	Valgfri Streng	Available when: type = paypal
paypal_price	Valgfri Flyd	Available when: type = paypal
paypal_thank_you_url	Valgfri Streng	Available when: type = paypal
paypal_cancel_url	Valgfri Streng	Available when: type = paypal
upi
upi_payee_id	Valgfri Streng	Available when: type = upi
upi_payee_name	Valgfri Streng	Available when: type = upi
upi_currency	Valgfri Streng	Available when: type = upi
upi_amount	Valgfri Flyd	Available when: type = upi
upi_transaction_id	Valgfri Streng	Available when: type = upi
upi_transaction_note	Valgfri Streng	Available when: type = upi
upi_transaction_reference	Valgfri Streng	Available when: type = upi
upi_thank_you_url	Valgfri Streng	Available when: type = upi
epc
epc_iban	Valgfri Streng	Available when: type = epc
epc_payee_name	Valgfri Streng	Available when: type = epc
epc_currency	Valgfri Streng	Available when: type = epc
epc_amount	Valgfri Flyd	Available when: type = epc
epc_bic	Valgfri Streng	Available when: type = epc
epc_remittance_reference	Valgfri Streng	Available when: type = epc
epc_remittance_text	Valgfri Streng	Available when: type = epc
information	Valgfri Streng	Available when: type = epc
pix
pix_payee_key	Valgfri Streng	Available when: type = pix
pix_payee_name	Valgfri Streng	Available when: type = pix
pix_currency	Valgfri Streng	Available when: type = pix
pix_amount	Valgfri Flyd	Available when: type = pix
pix_city	Valgfri Streng	Available when: type = pix
pix_transaction_id	Valgfri Streng	Available when: type = pix
pix_description	Valgfri Streng	Available when: type = pix

Parametre	Detaljer	Beskrivelse

Eksempel

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

Respons eksempel

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

Opdater

Slutpunkt

POST https://qr-kode.no/api/qr-codes/{qr_code_id}

Parametre	Detaljer	Beskrivelse
project_id	Valgfri Streng	-
name	Valgfri Streng	-
type	Valgfri Streng	Tilladte værdier: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`, `pix`
style	Valgfri Streng	Tilladte værdier: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Valgfri Streng	Tilladte værdier: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Valgfri Streng	Tilladte værdier: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Valgfri Streng	Tilladte værdier: `color`, `gradient`
foreground_color	Valgfri Streng	Available when: foreground_type = color
foreground_gradient_style	Valgfri Streng	Tilladte værdier: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Valgfri Streng	Available when: foreground_type = gradient
foreground_gradient_two	Valgfri Streng	Available when: foreground_type = gradient
background_color	Valgfri Streng
background_color_transparency	Valgfri Heltal	0 - 100
custom_eyes_color	Valgfri Boolean
eyes_inner_color	Valgfri Streng	Available when: custom_eyes_color = 1
eyes_outer_color	Valgfri Streng	Available when: custom_eyes_color = 1
qr_code_logo	Valgfri Fil	-
qr_code_logo_size	Valgfri Heltal	5-35
qr_code_background	Valgfri Fil	-
qr_code_background_transparency	Valgfri Heltal	0-100
qr_code_foreground	Valgfri Fil	-
qr_code_foreground_transparency	Valgfri Heltal	0-100
frame	Valgfri Streng	Tilladte værdier: `round_bottom_text`, `round_top_text`, `tooltip_bottom_text`, `tooltip_top_text`, `ribbon_bottom_text`, `ribbon_top_text`, `tooltip_snap_top_text`, `tooltip_snap_bottom_text`
frame_text	Valgfri Streng
frame_text_size	Valgfri Heltal	-5 -> 5
frame_text_font	Valgfri Streng	Tilladte værdier: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	Valgfri Boolean
frame_color	Valgfri Streng	Available when: frame_custom_colors = 1
frame_text_color	Valgfri Streng	Available when: frame_custom_colors = 1
size	Valgfri Heltal	50-2000
margin	Valgfri Heltal	0-25
ecc	Valgfri Streng	Tilladte værdier: `L`, `M`, `Q`, `H`
text	Valgfri Streng	Available when: type = text
url	Valgfri Streng	Available when: type = url
phone	Valgfri Streng	Available when: type = phone
sms	Valgfri Streng	Available when: type = sms
sms_body	Valgfri Streng	Available when: type = sms
email	Valgfri Streng	Available when: type = email
email_subject	Valgfri Streng	Available when: type = email
email_body	Valgfri Streng	Available when: type = email
whatsapp	Valgfri Streng	Available when: type = whatsapp
whatsapp_body	Valgfri Streng	Available when: type = whatsapp
facetime	Valgfri Streng	Available when: type = facetime
location
location_latitude	Valgfri Flyd	Available when: type = location
location_longitude	Valgfri Flyd	Available when: type = location
wifi
wifi_ssid	Valgfri Streng	Available when: type = wifi
wifi_encryption	Valgfri Streng	Tilladte værdier: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	Valgfri Streng	Available when: type = wifi
wifi_is_hidden	Valgfri Boolean	Available when: type = wifi
event	Valgfri Streng	Available when: type = event
event_location	Valgfri Streng	Available when: type = event
event_url	Valgfri Streng	Available when: type = event
event_note	Valgfri Streng	Available when: type = event
event_timezone	Valgfri Streng	Available when: type = event
event_start_datetime	Valgfri Streng	Available when: type = event
event_end_datetime	Valgfri Streng	Available when: type = event
event_first_alert_datetime	Valgfri Streng	Available when: type = event
event_second_alert_datetime	Valgfri Streng	Available when: type = event
crypto
crypto_coin	Valgfri Streng	Available when: type = crypto
crypto_address	Valgfri Streng	Available when: type = crypto
crypto_amount	Valgfri Streng	Available when: type = crypto
vcard
vcard_first_name	Valgfri Streng	Available when: type = vcard
vcard_last_name	Valgfri Streng	Available when: type = vcard
vcard_company	Valgfri Streng	Available when: type = vcard
vcard_phone_number_label[index]	Valgfri Streng	Available when: type = vcard
vcard_phone_number_value[index]	Valgfri Streng	Available when: type = vcard
vcard_email	Valgfri Streng	Available when: type = vcard
vcard_url	Valgfri Streng	Available when: type = vcard
vcard_job_title	Valgfri Streng	Available when: type = vcard
vcard_birthday	Valgfri Streng	Available when: type = vcard
vcard_street	Valgfri Streng	Available when: type = vcard
vcard_city	Valgfri Streng	Available when: type = vcard
vcard_zip	Valgfri Streng	Available when: type = vcard
vcard_region	Valgfri Streng	Available when: type = vcard
vcard_country	Valgfri Streng	Available when: type = vcard
vcard_note	Valgfri Streng	Available when: type = vcard
vcard_social_label[index]	Valgfri Streng	Available when: type = vcard
vcard_social_value[index]	Valgfri Streng	Available when: type = vcard
paypal
paypal_type	Valgfri Streng	Tilladte værdier: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	Valgfri Streng	Available when: type = paypal
paypal_title	Valgfri Streng	Available when: type = paypal
paypal_currency	Valgfri Streng	Available when: type = paypal
paypal_price	Valgfri Flyd	Available when: type = paypal
paypal_thank_you_url	Valgfri Streng	Available when: type = paypal
paypal_cancel_url	Valgfri Streng	Available when: type = paypal
upi
upi_payee_id	Valgfri Streng	Available when: type = upi
upi_payee_name	Valgfri Streng	Available when: type = upi
upi_currency	Valgfri Streng	Available when: type = upi
upi_amount	Valgfri Flyd	Available when: type = upi
upi_transaction_id	Valgfri Streng	Available when: type = upi
upi_transaction_note	Valgfri Streng	Available when: type = upi
upi_transaction_reference	Valgfri Streng	Available when: type = upi
upi_thank_you_url	Valgfri Streng	Available when: type = upi
epc
epc_iban	Valgfri Streng	Available when: type = epc
epc_payee_name	Valgfri Streng	Available when: type = epc
epc_currency	Valgfri Streng	Available when: type = epc
epc_amount	Valgfri Flyd	Available when: type = epc
epc_bic	Valgfri Streng	Available when: type = epc
epc_remittance_reference	Valgfri Streng	Available when: type = epc
epc_remittance_text	Valgfri Streng	Available when: type = epc
information	Valgfri Streng	Available when: type = epc
pix
pix_payee_key	Valgfri Streng	Available when: type = pix
pix_payee_name	Valgfri Streng	Available when: type = pix
pix_currency	Valgfri Streng	Available when: type = pix
pix_amount	Valgfri Flyd	Available when: type = pix
pix_city	Valgfri Streng	Available when: type = pix
pix_transaction_id	Valgfri Streng	Available when: type = pix
pix_description	Valgfri Streng	Available when: type = pix

Eksempel

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

Respons eksempel

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

Slet

Slutpunkt

DELETE https://qr-kode.no/api/qr-codes/{qr_code_id}

Eksempel

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