QR-koder - API-dokumentation

Hämta alla

Slutpunkt

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

Exempel

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

Parametrar	Detaljer	Beskrivning
page	Valfri Heltal	Sidnumret som du vill ha resultat från. Standardinställningen är `1`
results_per_page	Valfri Heltal	Hur många resultat vill du ha per sida. Tillåtna värden är: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standard är `25`.

Svars exempel

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

Hämta en

Slutpunkt

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

Exempel

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

Svars exempel

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

Skapa

Slutpunkt

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

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

Parametrar	Detaljer	Beskrivning

Exempel

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!' \

Svars exempel

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

Uppdatera

Slutpunkt

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

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

Exempel

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' \

Svars exempel

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

Radera

Slutpunkt

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

Exempel

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