QR codes

GET https://wavi.one/api/qr-codes/
curl --request GET \
--url 'https://wavi.one/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
المعلمات Details Description
page اختياري عدد صحيح رقم الصفحة التي ترغب في الحصول على النتائج منها. يتم تعيين القيمة الافتراضية إلى 1
results_per_page اختياري عدد صحيح كم عدد النتائج التي ترغب في كل صفحة. القيم المسموح بها هي: 10 , 25 , 50 , 100 , 250 , 500 , 1000. القيمة الافتراضية هي 25.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://wavi.one/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://wavi.one/api/qr-codes?&page=1", "last": "https://wavi.one/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://wavi.one/api/qr-codes?&page=1" } }
GET https://wavi.one/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://wavi.one/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://wavi.one/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" } }
POST https://wavi.one/api/qr-codes
المعلمات Details Description
project_id اختياري عدد صحيح -
name مطلوب سلسلة -
type مطلوب سلسلة القيم المسموح بها: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk اختياري قيمة منطقية Available when: type = text
style اختياري سلسلة القيم المسموح بها: square, dot, round, diamond, heart
inner_eye_style اختياري سلسلة القيم المسموح بها: square, dot, rounded, diamond, flower, leaf
outer_eye_style اختياري سلسلة القيم المسموح بها: square, circle, rounded, flower, leaf
foreground_type اختياري سلسلة القيم المسموح بها: color, gradient
foreground_color اختياري سلسلة Available when: foreground_type = color
foreground_gradient_style اختياري سلسلة القيم المسموح بها: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one اختياري سلسلة Available when: foreground_type = gradient
foreground_gradient_two اختياري سلسلة Available when: foreground_type = gradient
background_color اختياري سلسلة
background_color_transparency اختياري عدد صحيح
custom_eyes_color اختياري قيمة منطقية
eyes_inner_color اختياري سلسلة Available when: custom_eyes_color = 1
eyes_outer_color اختياري سلسلة Available when: custom_eyes_color = 1
qr_code_logo اختياري ملف -
qr_code_logo_size اختياري عدد صحيح 5-35
qr_code_background اختياري ملف -
qr_code_background_transparency اختياري عدد صحيح 0-100
qr_code_foreground اختياري ملف -
qr_code_foreground_transparency اختياري عدد صحيح 0-100
frame اختياري سلسلة القيم المسموح بها: 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 اختياري سلسلة
frame_text_size اختياري عدد صحيح -5 - 5
frame_text_font اختياري سلسلة القيم المسموح بها: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors اختياري قيمة منطقية
frame_color اختياري سلسلة Available when: frame_custom_colors = 1
frame_text_color اختياري سلسلة Available when: frame_custom_colors = 1
size اختياري عدد صحيح 50-2000
margin اختياري عدد صحيح 0-25
ecc اختياري سلسلة القيم المسموح بها: L, M, Q, H
text اختياري سلسلة Available when: type = text
url اختياري سلسلة Available when: type = url
phone اختياري سلسلة Available when: type = phone
sms اختياري سلسلة Available when: type = sms
sms_body اختياري سلسلة Available when: type = sms
email اختياري سلسلة Available when: type = email
whatsapp اختياري سلسلة Available when: type = whatsapp
whatsapp_body اختياري سلسلة Available when: type = whatsapp
facetime اختياري سلسلة Available when: type = facetime
location
location_latitude اختياري تعويم Available when: type = location
location_longitude اختياري تعويم Available when: type = location
wifi
wifi_ssid اختياري سلسلة Available when: type = wifi
wifi_encryption اختياري سلسلة القيم المسموح بها: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password اختياري سلسلة Available when: type = wifi
wifi_is_hidden اختياري قيمة منطقية Available when: type = wifi
event اختياري سلسلة Available when: type = event
event_location اختياري سلسلة Available when: type = event
event_url اختياري سلسلة Available when: type = event
event_note اختياري سلسلة Available when: type = event
event_timezone اختياري سلسلة Available when: type = event
event_start_datetime اختياري سلسلة Available when: type = event
event_end_datetime اختياري سلسلة Available when: type = event
event_first_alert_datetime اختياري سلسلة Available when: type = event
event_second_alert_datetime اختياري سلسلة Available when: type = event
crypto
crypto_coin اختياري سلسلة Available when: type = crypto
crypto_address اختياري سلسلة Available when: type = crypto
crypto_amount اختياري سلسلة Available when: type = crypto
vcard
vcard_first_name اختياري سلسلة Available when: type = vcard
vcard_last_name اختياري سلسلة Available when: type = vcard
vcard_company اختياري سلسلة Available when: type = vcard
vcard_phone_number_label[index] اختياري سلسلة Available when: type = vcard
vcard_phone_number_value[index] اختياري سلسلة Available when: type = vcard
vcard_email اختياري سلسلة Available when: type = vcard
vcard_url اختياري سلسلة Available when: type = vcard
vcard_job_title اختياري سلسلة Available when: type = vcard
vcard_birthday اختياري سلسلة Available when: type = vcard
vcard_street اختياري سلسلة Available when: type = vcard
vcard_city اختياري سلسلة Available when: type = vcard
vcard_zip اختياري سلسلة Available when: type = vcard
vcard_region اختياري سلسلة Available when: type = vcard
vcard_country اختياري سلسلة Available when: type = vcard
vcard_note اختياري سلسلة Available when: type = vcard
vcard_social_label[index] اختياري سلسلة Available when: type = vcard
vcard_social_value[index] اختياري سلسلة Available when: type = vcard
paypal
paypal_type اختياري سلسلة القيم المسموح بها: buy_now, add_to_cart, donation (type=paypal)
paypal_email اختياري سلسلة Available when: type = paypal
paypal_title اختياري سلسلة Available when: type = paypal
paypal_currency اختياري سلسلة Available when: type = paypal
paypal_price اختياري تعويم Available when: type = paypal
paypal_thank_you_url اختياري سلسلة Available when: type = paypal
paypal_cancel_url اختياري سلسلة Available when: type = paypal
upi
upi_payee_id اختياري سلسلة Available when: type = upi
upi_payee_name اختياري سلسلة Available when: type = upi
upi_currency اختياري سلسلة Available when: type = upi
upi_amount اختياري تعويم Available when: type = upi
upi_transaction_id اختياري سلسلة Available when: type = upi
upi_transaction_note اختياري سلسلة Available when: type = upi
upi_transaction_reference اختياري سلسلة Available when: type = upi
upi_thank_you_url اختياري سلسلة Available when: type = upi
epc
epc_iban اختياري سلسلة Available when: type = epc
epc_payee_name اختياري سلسلة Available when: type = epc
epc_currency اختياري سلسلة Available when: type = epc
epc_amount اختياري تعويم Available when: type = epc
epc_bic اختياري سلسلة Available when: type = epc
epc_remittance_reference اختياري سلسلة Available when: type = epc
epc_remittance_text اختياري سلسلة Available when: type = epc
information اختياري سلسلة Available when: type = epc
pix
pix_payee_key اختياري سلسلة Available when: type = pix
pix_payee_name اختياري سلسلة Available when: type = pix
pix_currency اختياري سلسلة Available when: type = pix
pix_amount اختياري تعويم Available when: type = pix
pix_city اختياري سلسلة Available when: type = pix
pix_transaction_id اختياري سلسلة Available when: type = pix
pix_description اختياري سلسلة Available when: type = pix
المعلمات Details Description
curl --request POST \
--url 'https://wavi.one/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 } }
POST https://wavi.one/api/qr-codes/{qr_code_id}
المعلمات Details Description
project_id اختياري سلسلة -
name اختياري سلسلة -
type اختياري سلسلة القيم المسموح بها: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
style اختياري سلسلة القيم المسموح بها: square, dot, round, diamond, heart
inner_eye_style اختياري سلسلة القيم المسموح بها: square, dot, rounded, diamond, flower, leaf
outer_eye_style اختياري سلسلة القيم المسموح بها: square, circle, rounded, flower, leaf
foreground_type اختياري سلسلة القيم المسموح بها: color, gradient
foreground_color اختياري سلسلة Available when: foreground_type = color
foreground_gradient_style اختياري سلسلة القيم المسموح بها: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one اختياري سلسلة Available when: foreground_type = gradient
foreground_gradient_two اختياري سلسلة Available when: foreground_type = gradient
background_color اختياري سلسلة
background_color_transparency اختياري عدد صحيح 0 - 100
custom_eyes_color اختياري قيمة منطقية
eyes_inner_color اختياري سلسلة Available when: custom_eyes_color = 1
eyes_outer_color اختياري سلسلة Available when: custom_eyes_color = 1
qr_code_logo اختياري ملف -
qr_code_logo_size اختياري عدد صحيح 5-35
qr_code_background اختياري ملف -
qr_code_background_transparency اختياري عدد صحيح 0-100
qr_code_foreground اختياري ملف -
qr_code_foreground_transparency اختياري عدد صحيح 0-100
frame اختياري سلسلة القيم المسموح بها: 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 اختياري سلسلة
frame_text_size اختياري عدد صحيح -5 -> 5
frame_text_font اختياري سلسلة القيم المسموح بها: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt
frame_custom_colors اختياري قيمة منطقية
frame_color اختياري سلسلة Available when: frame_custom_colors = 1
frame_text_color اختياري سلسلة Available when: frame_custom_colors = 1
size اختياري عدد صحيح 50-2000
margin اختياري عدد صحيح 0-25
ecc اختياري سلسلة القيم المسموح بها: L, M, Q, H
text اختياري سلسلة Available when: type = text
url اختياري سلسلة Available when: type = url
phone اختياري سلسلة Available when: type = phone
sms اختياري سلسلة Available when: type = sms
sms_body اختياري سلسلة Available when: type = sms
email اختياري سلسلة Available when: type = email
whatsapp اختياري سلسلة Available when: type = whatsapp
whatsapp_body اختياري سلسلة Available when: type = whatsapp
facetime اختياري سلسلة Available when: type = facetime
location
location_latitude اختياري تعويم Available when: type = location
location_longitude اختياري تعويم Available when: type = location
wifi
wifi_ssid اختياري سلسلة Available when: type = wifi
wifi_encryption اختياري سلسلة القيم المسموح بها: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password اختياري سلسلة Available when: type = wifi
wifi_is_hidden اختياري قيمة منطقية Available when: type = wifi
event اختياري سلسلة Available when: type = event
event_location اختياري سلسلة Available when: type = event
event_url اختياري سلسلة Available when: type = event
event_note اختياري سلسلة Available when: type = event
event_timezone اختياري سلسلة Available when: type = event
event_start_datetime اختياري سلسلة Available when: type = event
event_end_datetime اختياري سلسلة Available when: type = event
event_first_alert_datetime اختياري سلسلة Available when: type = event
event_second_alert_datetime اختياري سلسلة Available when: type = event
crypto
crypto_coin اختياري سلسلة Available when: type = crypto
crypto_address اختياري سلسلة Available when: type = crypto
crypto_amount اختياري سلسلة Available when: type = crypto
vcard
vcard_first_name اختياري سلسلة Available when: type = vcard
vcard_last_name اختياري سلسلة Available when: type = vcard
vcard_company اختياري سلسلة Available when: type = vcard
vcard_phone_number_label[index] اختياري سلسلة Available when: type = vcard
vcard_phone_number_value[index] اختياري سلسلة Available when: type = vcard
vcard_email اختياري سلسلة Available when: type = vcard
vcard_url اختياري سلسلة Available when: type = vcard
vcard_job_title اختياري سلسلة Available when: type = vcard
vcard_birthday اختياري سلسلة Available when: type = vcard
vcard_street اختياري سلسلة Available when: type = vcard
vcard_city اختياري سلسلة Available when: type = vcard
vcard_zip اختياري سلسلة Available when: type = vcard
vcard_region اختياري سلسلة Available when: type = vcard
vcard_country اختياري سلسلة Available when: type = vcard
vcard_note اختياري سلسلة Available when: type = vcard
vcard_social_label[index] اختياري سلسلة Available when: type = vcard
vcard_social_value[index] اختياري سلسلة Available when: type = vcard
paypal
paypal_type اختياري سلسلة القيم المسموح بها: buy_now, add_to_cart, donation (type=paypal)
paypal_email اختياري سلسلة Available when: type = paypal
paypal_title اختياري سلسلة Available when: type = paypal
paypal_currency اختياري سلسلة Available when: type = paypal
paypal_price اختياري تعويم Available when: type = paypal
paypal_thank_you_url اختياري سلسلة Available when: type = paypal
paypal_cancel_url اختياري سلسلة Available when: type = paypal
upi
upi_payee_id اختياري سلسلة Available when: type = upi
upi_payee_name اختياري سلسلة Available when: type = upi
upi_currency اختياري سلسلة Available when: type = upi
upi_amount اختياري تعويم Available when: type = upi
upi_transaction_id اختياري سلسلة Available when: type = upi
upi_transaction_note اختياري سلسلة Available when: type = upi
upi_transaction_reference اختياري سلسلة Available when: type = upi
upi_thank_you_url اختياري سلسلة Available when: type = upi
epc
epc_iban اختياري سلسلة Available when: type = epc
epc_payee_name اختياري سلسلة Available when: type = epc
epc_currency اختياري سلسلة Available when: type = epc
epc_amount اختياري تعويم Available when: type = epc
epc_bic اختياري سلسلة Available when: type = epc
epc_remittance_reference اختياري سلسلة Available when: type = epc
epc_remittance_text اختياري سلسلة Available when: type = epc
information اختياري سلسلة Available when: type = epc
pix
pix_payee_key اختياري سلسلة Available when: type = pix
pix_payee_name اختياري سلسلة Available when: type = pix
pix_currency اختياري سلسلة Available when: type = pix
pix_amount اختياري تعويم Available when: type = pix
pix_city اختياري سلسلة Available when: type = pix
pix_transaction_id اختياري سلسلة Available when: type = pix
pix_description اختياري سلسلة Available when: type = pix
curl --request POST \
--url 'https://wavi.one/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 https://wavi.one/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://wavi.one/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \