QR codes

Retrieve all

GET https://osite.pro/api/qr-codes/
curl --request GET \
--url 'https://osite.pro/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://osite.pro/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://osite.pro/api/qr-codes?&page=1", "last": "https://osite.pro/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://osite.pro/api/qr-codes?&page=1" } }

Retrieve one

GET https://osite.pro/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://osite.pro/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://osite.pro/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" } }

Create

POST https://osite.pro/api/qr-codes
Parameters Details Description
project_id Optional Integer -
name Required String -
type Required String Allowed values: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk Optional Boolean Available when: type = text
style Optional String Allowed values: square, dot, round, diamond, heart
inner_eye_style Optional String Allowed values: square, dot, rounded, diamond, flower, leaf
outer_eye_style Optional String Allowed values: square, circle, rounded, flower, leaf
foreground_type Optional String Allowed values: color, gradient
foreground_color Optional String Available when: foreground_type = color
foreground_gradient_style Optional String Allowed values: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Optional String Available when: foreground_type = gradient
foreground_gradient_two Optional String Available when: foreground_type = gradient
background_color Optional String
background_color_transparency Optional Integer
custom_eyes_color Optional Boolean
eyes_inner_color Optional String Available when: custom_eyes_color = 1
eyes_outer_color Optional String Available when: custom_eyes_color = 1
qr_code_logo Optional File -
qr_code_logo_size Optional Integer 5-35
qr_code_background Optional File -
qr_code_background_transparency Optional Integer 0-100
qr_code_foreground Optional File -
qr_code_foreground_transparency Optional Integer 0-100
frame Optional String Allowed values: 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 Optional String
frame_text_size Optional Integer -5 - 5
frame_text_font Optional String Allowed values: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Optional Boolean
frame_color Optional String Available when: frame_custom_colors = 1
frame_text_color Optional String Available when: frame_custom_colors = 1
size Optional Integer 50-2000
margin Optional Integer 0-25
ecc Optional String Allowed values: L, M, Q, H
text Optional String Available when: type = text
url Optional String Available when: type = url
phone Optional String Available when: type = phone
sms Optional String Available when: type = sms
sms_body Optional String Available when: type = sms
email Optional String Available when: type = email
whatsapp Optional String Available when: type = whatsapp
whatsapp_body Optional String Available when: type = whatsapp
facetime Optional String Available when: type = facetime
location
location_latitude Optional Float Available when: type = location
location_longitude Optional Float Available when: type = location
wifi
wifi_ssid Optional String Available when: type = wifi
wifi_encryption Optional String Allowed values: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Optional String Available when: type = wifi
wifi_is_hidden Optional Boolean Available when: type = wifi
event Optional String Available when: type = event
event_location Optional String Available when: type = event
event_url Optional String Available when: type = event
event_note Optional String Available when: type = event
event_timezone Optional String Available when: type = event
event_start_datetime Optional String Available when: type = event
event_end_datetime Optional String Available when: type = event
event_first_alert_datetime Optional String Available when: type = event
event_second_alert_datetime Optional String Available when: type = event
crypto
crypto_coin Optional String Available when: type = crypto
crypto_address Optional String Available when: type = crypto
crypto_amount Optional String Available when: type = crypto
vcard
vcard_first_name Optional String Available when: type = vcard
vcard_last_name Optional String Available when: type = vcard
vcard_company Optional String Available when: type = vcard
vcard_phone_number_label[index] Optional String Available when: type = vcard
vcard_phone_number_value[index] Optional String Available when: type = vcard
vcard_email Optional String Available when: type = vcard
vcard_url Optional String Available when: type = vcard
vcard_job_title Optional String Available when: type = vcard
vcard_birthday Optional String Available when: type = vcard
vcard_street Optional String Available when: type = vcard
vcard_city Optional String Available when: type = vcard
vcard_zip Optional String Available when: type = vcard
vcard_region Optional String Available when: type = vcard
vcard_country Optional String Available when: type = vcard
vcard_note Optional String Available when: type = vcard
vcard_social_label[index] Optional String Available when: type = vcard
vcard_social_value[index] Optional String Available when: type = vcard
paypal
paypal_type Optional String Allowed values: buy_now, add_to_cart, donation (type=paypal)
paypal_email Optional String Available when: type = paypal
paypal_title Optional String Available when: type = paypal
paypal_currency Optional String Available when: type = paypal
paypal_price Optional Float Available when: type = paypal
paypal_thank_you_url Optional String Available when: type = paypal
paypal_cancel_url Optional String Available when: type = paypal
upi
upi_payee_id Optional String Available when: type = upi
upi_payee_name Optional String Available when: type = upi
upi_currency Optional String Available when: type = upi
upi_amount Optional Float Available when: type = upi
upi_transaction_id Optional String Available when: type = upi
upi_transaction_note Optional String Available when: type = upi
upi_transaction_reference Optional String Available when: type = upi
upi_thank_you_url Optional String Available when: type = upi
epc
epc_iban Optional String Available when: type = epc
epc_payee_name Optional String Available when: type = epc
epc_currency Optional String Available when: type = epc
epc_amount Optional Float Available when: type = epc
epc_bic Optional String Available when: type = epc
epc_remittance_reference Optional String Available when: type = epc
epc_remittance_text Optional String Available when: type = epc
information Optional String Available when: type = epc
pix
pix_payee_key Optional String Available when: type = pix
pix_payee_name Optional String Available when: type = pix
pix_currency Optional String Available when: type = pix
pix_amount Optional Float Available when: type = pix
pix_city Optional String Available when: type = pix
pix_transaction_id Optional String Available when: type = pix
pix_description Optional String Available when: type = pix
Parameters Details Description
curl --request POST \
--url 'https://osite.pro/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \
{ "data": { "id": 1 } }

Update

POST https://osite.pro/api/qr-codes/{qr_code_id}
Parameters Details Description
project_id Optional String -
name Optional String -
type Optional String Allowed values: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style Optional String Allowed values: square, dot, round, diamond, heart
inner_eye_style Optional String Allowed values: square, dot, rounded, diamond, flower, leaf
outer_eye_style Optional String Allowed values: square, circle, rounded, flower, leaf
foreground_type Optional String Allowed values: color, gradient
foreground_color Optional String Available when: foreground_type = color
foreground_gradient_style Optional String Allowed values: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one Optional String Available when: foreground_type = gradient
foreground_gradient_two Optional String Available when: foreground_type = gradient
background_color Optional String
background_color_transparency Optional Integer 0 - 100
custom_eyes_color Optional Boolean
eyes_inner_color Optional String Available when: custom_eyes_color = 1
eyes_outer_color Optional String Available when: custom_eyes_color = 1
qr_code_logo Optional File -
qr_code_logo_size Optional Integer 5-35
qr_code_background Optional File -
qr_code_background_transparency Optional Integer 0-100
qr_code_foreground Optional File -
qr_code_foreground_transparency Optional Integer 0-100
frame Optional String Allowed values: 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 Optional String
frame_text_size Optional Integer -5 -> 5
frame_text_font Optional String Allowed values: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, lucida_console, monaco, comic_sans_ms, impact
frame_custom_colors Optional Boolean
frame_color Optional String Available when: frame_custom_colors = 1
frame_text_color Optional String Available when: frame_custom_colors = 1
size Optional Integer 50-2000
margin Optional Integer 0-25
ecc Optional String Allowed values: L, M, Q, H
text Optional String Available when: type = text
url Optional String Available when: type = url
phone Optional String Available when: type = phone
sms Optional String Available when: type = sms
sms_body Optional String Available when: type = sms
email Optional String Available when: type = email
whatsapp Optional String Available when: type = whatsapp
whatsapp_body Optional String Available when: type = whatsapp
facetime Optional String Available when: type = facetime
location
location_latitude Optional Float Available when: type = location
location_longitude Optional Float Available when: type = location
wifi
wifi_ssid Optional String Available when: type = wifi
wifi_encryption Optional String Allowed values: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password Optional String Available when: type = wifi
wifi_is_hidden Optional Boolean Available when: type = wifi
event Optional String Available when: type = event
event_location Optional String Available when: type = event
event_url Optional String Available when: type = event
event_note Optional String Available when: type = event
event_timezone Optional String Available when: type = event
event_start_datetime Optional String Available when: type = event
event_end_datetime Optional String Available when: type = event
event_first_alert_datetime Optional String Available when: type = event
event_second_alert_datetime Optional String Available when: type = event
crypto
crypto_coin Optional String Available when: type = crypto
crypto_address Optional String Available when: type = crypto
crypto_amount Optional String Available when: type = crypto
vcard
vcard_first_name Optional String Available when: type = vcard
vcard_last_name Optional String Available when: type = vcard
vcard_company Optional String Available when: type = vcard
vcard_phone_number_label[index] Optional String Available when: type = vcard
vcard_phone_number_value[index] Optional String Available when: type = vcard
vcard_email Optional String Available when: type = vcard
vcard_url Optional String Available when: type = vcard
vcard_job_title Optional String Available when: type = vcard
vcard_birthday Optional String Available when: type = vcard
vcard_street Optional String Available when: type = vcard
vcard_city Optional String Available when: type = vcard
vcard_zip Optional String Available when: type = vcard
vcard_region Optional String Available when: type = vcard
vcard_country Optional String Available when: type = vcard
vcard_note Optional String Available when: type = vcard
vcard_social_label[index] Optional String Available when: type = vcard
vcard_social_value[index] Optional String Available when: type = vcard
paypal
paypal_type Optional String Allowed values: buy_now, add_to_cart, donation (type=paypal)
paypal_email Optional String Available when: type = paypal
paypal_title Optional String Available when: type = paypal
paypal_currency Optional String Available when: type = paypal
paypal_price Optional Float Available when: type = paypal
paypal_thank_you_url Optional String Available when: type = paypal
paypal_cancel_url Optional String Available when: type = paypal
upi
upi_payee_id Optional String Available when: type = upi
upi_payee_name Optional String Available when: type = upi
upi_currency Optional String Available when: type = upi
upi_amount Optional Float Available when: type = upi
upi_transaction_id Optional String Available when: type = upi
upi_transaction_note Optional String Available when: type = upi
upi_transaction_reference Optional String Available when: type = upi
upi_thank_you_url Optional String Available when: type = upi
epc
epc_iban Optional String Available when: type = epc
epc_payee_name Optional String Available when: type = epc
epc_currency Optional String Available when: type = epc
epc_amount Optional Float Available when: type = epc
epc_bic Optional String Available when: type = epc
epc_remittance_reference Optional String Available when: type = epc
epc_remittance_text Optional String Available when: type = epc
information Optional String Available when: type = epc
pix
pix_payee_key Optional String Available when: type = pix
pix_payee_name Optional String Available when: type = pix
pix_currency Optional String Available when: type = pix
pix_amount Optional Float Available when: type = pix
pix_city Optional String Available when: type = pix
pix_transaction_id Optional String Available when: type = pix
pix_description Optional String Available when: type = pix
curl --request POST \
--url 'https://osite.pro/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
{ "data": { "id": 1 } }

Delete

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