کدهای QR

همه را بازیابی کنید

نقطه پایانی

GET https://oovo.ir/api/qr-codes/

نمونه

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

پارامترها	جزئیات	شرح
page	اختیاری Integer	شماره صفحه ای که می‌خواهید از آن نتیجه بگیرد. پیش‌فرض `1` است.
results_per_page	اختیاری Integer	در هر صفحه چند نتیجه می‌خواهید. مقادیر مجاز عبارتند از: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. پیش‌فرض `25` است.

نمونه پاسخ

{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://oovo.ir/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://oovo.ir/api/qr-codes?&page=1", "last": "https://oovo.ir/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://oovo.ir/api/qr-codes?&page=1" } }

یکی را بازیابی کنید

نقطه پایانی

GET https://oovo.ir/api/qr-codes/{qr_code_id}

نمونه

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

نمونه پاسخ

{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://oovo.ir/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" } }

ایجاد

نقطه پایانی

POST https://oovo.ir/api/qr-codes

پارامترها	جزئیات	شرح
project_id	اختیاری Integer	-
name	ضروری String	-
type	ضروری String	مقادیر مجاز: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`
style	اختیاری String	مقادیر مجاز: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	اختیاری String	مقادیر مجاز: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	اختیاری String	مقادیر مجاز: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	اختیاری String	مقادیر مجاز: `color`, `gradient`
foreground_color	اختیاری String	زمانی که در دسترس است: foreground_type = color
foreground_gradient_style	اختیاری String	مقادیر مجاز: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	اختیاری String	زمانی که در دسترس است: foreground_type = gradient
foreground_gradient_two	اختیاری String	زمانی که در دسترس است: foreground_type = gradient
background_color	اختیاری String
background_color_transparency	اختیاری Integer
custom_eyes_color	اختیاری Boolean
eyes_inner_color	اختیاری String	زمانی که در دسترس است: custom_eyes_color = 1
eyes_outer_color	اختیاری String	زمانی که در دسترس است: custom_eyes_color = 1
qr_code_logo	اختیاری فایل	-
qr_code_logo_size	اختیاری Integer	5-35
qr_code_background	اختیاری فایل	-
qr_code_background_transparency	اختیاری Integer	0-100
frame	اختیاری String	مقادیر مجاز: `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	اختیاری String
frame_text_size	اختیاری Integer	-5 - 5
frame_text_font	اختیاری String	مقادیر مجاز: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	اختیاری Boolean
frame_color	اختیاری String	زمانی که در دسترس است: frame_custom_colors = 1
frame_text_color	اختیاری String	زمانی که در دسترس است: frame_custom_colors = 1
size	اختیاری Integer	50-2000
margin	اختیاری Integer	0-25
ecc	اختیاری String	مقادیر مجاز: `L`, `M`, `Q`, `H`
text	اختیاری String	زمانی که در دسترس است: type = text
url	اختیاری String	زمانی که در دسترس است: type = url
phone	اختیاری String	زمانی که در دسترس است: type = phone
sms	اختیاری String	زمانی که در دسترس است: type = sms
sms_body	اختیاری String	زمانی که در دسترس است: type = sms
email	اختیاری String	زمانی که در دسترس است: type = email
email_subject	اختیاری String	زمانی که در دسترس است: type = email
email_body	اختیاری String	زمانی که در دسترس است: type = email
whatsapp	اختیاری String	زمانی که در دسترس است: type = whatsapp
whatsapp_body	اختیاری String	زمانی که در دسترس است: type = whatsapp
facetime	اختیاری String	زمانی که در دسترس است: type = facetime
location
location_latitude	اختیاری Float	زمانی که در دسترس است: type = location
location_longitude	اختیاری Float	زمانی که در دسترس است: type = location
wifi
wifi_ssid	اختیاری String	زمانی که در دسترس است: type = wifi
wifi_encryption	اختیاری String	مقادیر مجاز: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	اختیاری String	زمانی که در دسترس است: type = wifi
wifi_is_hidden	اختیاری Boolean	زمانی که در دسترس است: type = wifi
event	اختیاری String	زمانی که در دسترس است: type = event
event_location	اختیاری String	زمانی که در دسترس است: type = event
event_url	اختیاری String	زمانی که در دسترس است: type = event
event_note	اختیاری String	زمانی که در دسترس است: type = event
event_timezone	اختیاری String	زمانی که در دسترس است: type = event
event_start_datetime	اختیاری String	زمانی که در دسترس است: type = event
event_end_datetime	اختیاری String	زمانی که در دسترس است: type = event
crypto
crypto_coin	اختیاری String	زمانی که در دسترس است: type = crypto
crypto_address	اختیاری String	زمانی که در دسترس است: type = crypto
crypto_amount	اختیاری String	زمانی که در دسترس است: type = crypto
vcard
vcard_first_name	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_last_name	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_company	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_phone_number_label[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_phone_number_value[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_email	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_url	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_job_title	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_birthday	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_street	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_city	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_zip	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_region	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_country	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_note	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_social_label[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_social_value[index]	اختیاری String	زمانی که در دسترس است: type = vcard
paypal
paypal_type	اختیاری String	مقادیر مجاز: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_title	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_currency	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_price	اختیاری Float	زمانی که در دسترس است: type = paypal
paypal_thank_you_url	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_cancel_url	اختیاری String	زمانی که در دسترس است: type = paypal
upi
upi_payee_id	اختیاری String	زمانی که در دسترس است: type = upi
upi_payee_name	اختیاری String	زمانی که در دسترس است: type = upi
upi_currency	اختیاری String	زمانی که در دسترس است: type = upi
upi_amount	اختیاری Float	زمانی که در دسترس است: type = upi
upi_transaction_id	اختیاری String	زمانی که در دسترس است: type = upi
upi_transaction_note	اختیاری String	زمانی که در دسترس است: type = upi
upi_transaction_reference	اختیاری String	زمانی که در دسترس است: type = upi
upi_thank_you_url	اختیاری String	زمانی که در دسترس است: type = upi
epc
epc_iban	اختیاری String	زمانی که در دسترس است: type = epc
epc_payee_name	اختیاری String	زمانی که در دسترس است: type = epc
epc_currency	اختیاری String	زمانی که در دسترس است: type = epc
epc_amount	اختیاری Float	زمانی که در دسترس است: type = epc
epc_bic	اختیاری String	زمانی که در دسترس است: type = epc
epc_remittance_reference	اختیاری String	زمانی که در دسترس است: type = epc
epc_remittance_text	اختیاری String	زمانی که در دسترس است: type = epc
information	اختیاری String	زمانی که در دسترس است: type = epc

پارامترها	جزئیات	شرح

نمونه

curl --request POST \
--url 'https://oovo.ir/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://oovo.ir/api/qr-codes/{qr_code_id}

پارامترها	جزئیات	شرح
project_id	اختیاری String	-
name	اختیاری String	-
type	اختیاری String	مقادیر مجاز: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`
style	اختیاری String	مقادیر مجاز: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	اختیاری String	مقادیر مجاز: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	اختیاری String	مقادیر مجاز: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	اختیاری String	مقادیر مجاز: `color`, `gradient`
foreground_color	اختیاری String	زمانی که در دسترس است: foreground_type = color
foreground_gradient_style	اختیاری String	مقادیر مجاز: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	اختیاری String	زمانی که در دسترس است: foreground_type = gradient
foreground_gradient_two	اختیاری String	زمانی که در دسترس است: foreground_type = gradient
background_color	اختیاری String
background_color_transparency	اختیاری Integer	0 - 100
custom_eyes_color	اختیاری Boolean
eyes_inner_color	اختیاری String	زمانی که در دسترس است: custom_eyes_color = 1
eyes_outer_color	اختیاری String	زمانی که در دسترس است: custom_eyes_color = 1
qr_code_logo	اختیاری فایل	-
qr_code_logo_size	اختیاری Integer	5-35
qr_code_background	اختیاری فایل	-
qr_code_background_transparency	اختیاری Integer	0-100
frame	اختیاری String	مقادیر مجاز: `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	اختیاری String
frame_text_size	اختیاری Integer	-5 -> 5
frame_text_font	اختیاری String	مقادیر مجاز: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	اختیاری Boolean
frame_color	اختیاری String	زمانی که در دسترس است: frame_custom_colors = 1
frame_text_color	اختیاری String	زمانی که در دسترس است: frame_custom_colors = 1
size	اختیاری Integer	50-2000
margin	اختیاری Integer	0-25
ecc	اختیاری String	مقادیر مجاز: `L`, `M`, `Q`, `H`
text	اختیاری String	زمانی که در دسترس است: type = text
url	اختیاری String	زمانی که در دسترس است: type = url
phone	اختیاری String	زمانی که در دسترس است: type = phone
sms	اختیاری String	زمانی که در دسترس است: type = sms
sms_body	اختیاری String	زمانی که در دسترس است: type = sms
email	اختیاری String	زمانی که در دسترس است: type = email
email_subject	اختیاری String	زمانی که در دسترس است: type = email
email_body	اختیاری String	زمانی که در دسترس است: type = email
whatsapp	اختیاری String	زمانی که در دسترس است: type = whatsapp
whatsapp_body	اختیاری String	زمانی که در دسترس است: type = whatsapp
facetime	اختیاری String	زمانی که در دسترس است: type = facetime
location
location_latitude	اختیاری Float	زمانی که در دسترس است: type = location
location_longitude	اختیاری Float	زمانی که در دسترس است: type = location
wifi
wifi_ssid	اختیاری String	زمانی که در دسترس است: type = wifi
wifi_encryption	اختیاری String	مقادیر مجاز: `nopass`, `WEP`, `WPA/WPA2`, `H (type=wifi)`
wifi_password	اختیاری String	زمانی که در دسترس است: type = wifi
wifi_is_hidden	اختیاری Boolean	زمانی که در دسترس است: type = wifi
event	اختیاری String	زمانی که در دسترس است: type = event
event_location	اختیاری String	زمانی که در دسترس است: type = event
event_url	اختیاری String	زمانی که در دسترس است: type = event
event_note	اختیاری String	زمانی که در دسترس است: type = event
event_timezone	اختیاری String	زمانی که در دسترس است: type = event
event_start_datetime	اختیاری String	زمانی که در دسترس است: type = event
event_end_datetime	اختیاری String	زمانی که در دسترس است: type = event
crypto
crypto_coin	اختیاری String	زمانی که در دسترس است: type = crypto
crypto_address	اختیاری String	زمانی که در دسترس است: type = crypto
crypto_amount	اختیاری String	زمانی که در دسترس است: type = crypto
vcard
vcard_first_name	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_last_name	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_company	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_phone_number_label[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_phone_number_value[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_email	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_url	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_job_title	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_birthday	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_street	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_city	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_zip	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_region	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_country	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_note	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_social_label[index]	اختیاری String	زمانی که در دسترس است: type = vcard
vcard_social_value[index]	اختیاری String	زمانی که در دسترس است: type = vcard
paypal
paypal_type	اختیاری String	مقادیر مجاز: `buy_now`, `add_to_cart`, `donation (type=paypal)`
paypal_email	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_title	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_currency	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_price	اختیاری Float	زمانی که در دسترس است: type = paypal
paypal_thank_you_url	اختیاری String	زمانی که در دسترس است: type = paypal
paypal_cancel_url	اختیاری String	زمانی که در دسترس است: type = paypal
upi
upi_payee_id	اختیاری String	زمانی که در دسترس است: type = upi
upi_payee_name	اختیاری String	زمانی که در دسترس است: type = upi
upi_currency	اختیاری String	زمانی که در دسترس است: type = upi
upi_amount	اختیاری Float	زمانی که در دسترس است: type = upi
upi_transaction_id	اختیاری String	زمانی که در دسترس است: type = upi
upi_transaction_note	اختیاری String	زمانی که در دسترس است: type = upi
upi_transaction_reference	اختیاری String	زمانی که در دسترس است: type = upi
upi_thank_you_url	اختیاری String	زمانی که در دسترس است: type = upi
epc
epc_iban	اختیاری String	زمانی که در دسترس است: type = epc
epc_payee_name	اختیاری String	زمانی که در دسترس است: type = epc
epc_currency	اختیاری String	زمانی که در دسترس است: type = epc
epc_amount	اختیاری Float	زمانی که در دسترس است: type = epc
epc_bic	اختیاری String	زمانی که در دسترس است: type = epc
epc_remittance_reference	اختیاری String	زمانی که در دسترس است: type = epc
epc_remittance_text	اختیاری String	زمانی که در دسترس است: type = epc
information	اختیاری String	زمانی که در دسترس است: type = epc

نمونه

curl --request POST \
--url 'https://oovo.ir/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://oovo.ir/api/qr-codes/{qr_code_id}

نمونه

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