کدهای QR

GET https://tistos.com/api/qr-codes/
curl --request GET \
--url 'https://tistos.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها جزئیات توضیحات
page اختیاری عدد صحیح شماره صفحه‌ای که می‌خواهید نتایج از آنجا بگیرید. به‌صورت پیش‌فرض 1 است.
results_per_page اختیاری عدد صحیح تعداد نتایج مورد نظرتان برای هر صفحه چقدر است. مقادیر مجاز عبارتند از: 10 , 25 , 50 , 100 , 250 , 500 , 1000. به‌طور پیش‌فرض به 25 تنظیم شده است.
{ "data": [ { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://tistos.com/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://tistos.com/api/qr-codes?&page=1", "last": "https://tistos.com/api/qr-codes?&page=1", "next": null, "prev": null, "self": "https://tistos.com/api/qr-codes?&page=1" } }
GET https://tistos.com/api/qr-codes/{qr_code_id}
curl --request GET \
--url 'https://tistos.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "url", "name": "Example name", "qr_code": "https://tistos.com/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://tistos.com/api/qr-codes
پارامترها جزئیات توضیحات
project_id اختیاری عدد صحیح -
name ضروری رشته -
type ضروری رشته مقادیر مجاز: text, url, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix
is_bulk اختیاری بولیاین قابل دسترس هنگام: 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 اختیاری رشته قابل دسترس هنگام: foreground_type = color
foreground_gradient_style اختیاری رشته مقادیر مجاز: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one اختیاری رشته قابل دسترس هنگام: foreground_type = gradient
foreground_gradient_two اختیاری رشته قابل دسترس هنگام: foreground_type = gradient
background_color اختیاری رشته
background_color_transparency اختیاری عدد صحیح
custom_eyes_color اختیاری بولیاین
eyes_inner_color اختیاری رشته قابل دسترس هنگام: custom_eyes_color = 1
eyes_outer_color اختیاری رشته قابل دسترس هنگام: 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 اختیاری رشته قابل دسترس هنگام: frame_custom_colors = 1
frame_text_color اختیاری رشته قابل دسترس هنگام: frame_custom_colors = 1
size اختیاری عدد صحیح 50-2000
margin اختیاری عدد صحیح 0-25
ecc اختیاری رشته مقادیر مجاز: L, M, Q, H
text اختیاری رشته قابل دسترس هنگام: type = text
url اختیاری رشته قابل دسترس هنگام: type = url
phone اختیاری رشته قابل دسترس هنگام: type = phone
sms اختیاری رشته قابل دسترس هنگام: type = sms
sms_body اختیاری رشته قابل دسترس هنگام: type = sms
email اختیاری رشته قابل دسترس هنگام: type = email
whatsapp اختیاری رشته قابل دسترس هنگام: type = whatsapp
whatsapp_body اختیاری رشته قابل دسترس هنگام: type = whatsapp
facetime اختیاری رشته قابل دسترس هنگام: type = facetime
location
location_latitude اختیاری اعشاری قابل دسترس هنگام: type = location
location_longitude اختیاری اعشاری قابل دسترس هنگام: type = location
wifi
wifi_ssid اختیاری رشته قابل دسترس هنگام: type = wifi
wifi_encryption اختیاری رشته مقادیر مجاز: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password اختیاری رشته قابل دسترس هنگام: type = wifi
wifi_is_hidden اختیاری بولیاین قابل دسترس هنگام: type = wifi
event اختیاری رشته قابل دسترس هنگام: type = event
event_location اختیاری رشته قابل دسترس هنگام: type = event
event_url اختیاری رشته قابل دسترس هنگام: type = event
event_note اختیاری رشته قابل دسترس هنگام: type = event
event_timezone اختیاری رشته قابل دسترس هنگام: type = event
event_start_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_end_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_first_alert_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_second_alert_datetime اختیاری رشته قابل دسترس هنگام: type = event
crypto
crypto_coin اختیاری رشته قابل دسترس هنگام: type = crypto
crypto_address اختیاری رشته قابل دسترس هنگام: type = crypto
crypto_amount اختیاری رشته قابل دسترس هنگام: type = crypto
vcard
vcard_first_name اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_last_name اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_company اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_phone_number_label[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_phone_number_value[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_email اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_url اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_job_title اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_birthday اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_street اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_city اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_zip اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_region اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_country اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_note اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_social_label[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_social_value[index] اختیاری رشته قابل دسترس هنگام: type = vcard
paypal
paypal_type اختیاری رشته مقادیر مجاز: buy_now, add_to_cart, donation (type=paypal)
paypal_email اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_title اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_currency اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_price اختیاری اعشاری قابل دسترس هنگام: type = paypal
paypal_thank_you_url اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_cancel_url اختیاری رشته قابل دسترس هنگام: type = paypal
upi
upi_payee_id اختیاری رشته قابل دسترس هنگام: type = upi
upi_payee_name اختیاری رشته قابل دسترس هنگام: type = upi
upi_currency اختیاری رشته قابل دسترس هنگام: type = upi
upi_amount اختیاری اعشاری قابل دسترس هنگام: type = upi
upi_transaction_id اختیاری رشته قابل دسترس هنگام: type = upi
upi_transaction_note اختیاری رشته قابل دسترس هنگام: type = upi
upi_transaction_reference اختیاری رشته قابل دسترس هنگام: type = upi
upi_thank_you_url اختیاری رشته قابل دسترس هنگام: type = upi
epc
epc_iban اختیاری رشته قابل دسترس هنگام: type = epc
epc_payee_name اختیاری رشته قابل دسترس هنگام: type = epc
epc_currency اختیاری رشته قابل دسترس هنگام: type = epc
epc_amount اختیاری اعشاری قابل دسترس هنگام: type = epc
epc_bic اختیاری رشته قابل دسترس هنگام: type = epc
epc_remittance_reference اختیاری رشته قابل دسترس هنگام: type = epc
epc_remittance_text اختیاری رشته قابل دسترس هنگام: type = epc
information اختیاری رشته قابل دسترس هنگام: type = epc
pix
pix_payee_key اختیاری رشته قابل دسترس هنگام: type = pix
pix_payee_name اختیاری رشته قابل دسترس هنگام: type = pix
pix_currency اختیاری رشته قابل دسترس هنگام: type = pix
pix_amount اختیاری اعشاری قابل دسترس هنگام: type = pix
pix_city اختیاری رشته قابل دسترس هنگام: type = pix
pix_transaction_id اختیاری رشته قابل دسترس هنگام: type = pix
pix_description اختیاری رشته قابل دسترس هنگام: type = pix
پارامترها جزئیات توضیحات
curl --request POST \
--url 'https://tistos.com/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://tistos.com/api/qr-codes/{qr_code_id}
پارامترها جزئیات توضیحات
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 اختیاری رشته قابل دسترس هنگام: foreground_type = color
foreground_gradient_style اختیاری رشته مقادیر مجاز: vertical, horizontal, diagonal, inverse_diagonal, radial
foreground_gradient_one اختیاری رشته قابل دسترس هنگام: foreground_type = gradient
foreground_gradient_two اختیاری رشته قابل دسترس هنگام: foreground_type = gradient
background_color اختیاری رشته
background_color_transparency اختیاری عدد صحیح 0 - 100
custom_eyes_color اختیاری بولیاین
eyes_inner_color اختیاری رشته قابل دسترس هنگام: custom_eyes_color = 1
eyes_outer_color اختیاری رشته قابل دسترس هنگام: 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 اختیاری رشته قابل دسترس هنگام: frame_custom_colors = 1
frame_text_color اختیاری رشته قابل دسترس هنگام: frame_custom_colors = 1
size اختیاری عدد صحیح 50-2000
margin اختیاری عدد صحیح 0-25
ecc اختیاری رشته مقادیر مجاز: L, M, Q, H
text اختیاری رشته قابل دسترس هنگام: type = text
url اختیاری رشته قابل دسترس هنگام: type = url
phone اختیاری رشته قابل دسترس هنگام: type = phone
sms اختیاری رشته قابل دسترس هنگام: type = sms
sms_body اختیاری رشته قابل دسترس هنگام: type = sms
email اختیاری رشته قابل دسترس هنگام: type = email
whatsapp اختیاری رشته قابل دسترس هنگام: type = whatsapp
whatsapp_body اختیاری رشته قابل دسترس هنگام: type = whatsapp
facetime اختیاری رشته قابل دسترس هنگام: type = facetime
location
location_latitude اختیاری اعشاری قابل دسترس هنگام: type = location
location_longitude اختیاری اعشاری قابل دسترس هنگام: type = location
wifi
wifi_ssid اختیاری رشته قابل دسترس هنگام: type = wifi
wifi_encryption اختیاری رشته مقادیر مجاز: nopass, WEP, WPA/WPA2, H (type=wifi)
wifi_password اختیاری رشته قابل دسترس هنگام: type = wifi
wifi_is_hidden اختیاری بولیاین قابل دسترس هنگام: type = wifi
event اختیاری رشته قابل دسترس هنگام: type = event
event_location اختیاری رشته قابل دسترس هنگام: type = event
event_url اختیاری رشته قابل دسترس هنگام: type = event
event_note اختیاری رشته قابل دسترس هنگام: type = event
event_timezone اختیاری رشته قابل دسترس هنگام: type = event
event_start_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_end_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_first_alert_datetime اختیاری رشته قابل دسترس هنگام: type = event
event_second_alert_datetime اختیاری رشته قابل دسترس هنگام: type = event
crypto
crypto_coin اختیاری رشته قابل دسترس هنگام: type = crypto
crypto_address اختیاری رشته قابل دسترس هنگام: type = crypto
crypto_amount اختیاری رشته قابل دسترس هنگام: type = crypto
vcard
vcard_first_name اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_last_name اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_company اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_phone_number_label[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_phone_number_value[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_email اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_url اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_job_title اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_birthday اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_street اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_city اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_zip اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_region اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_country اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_note اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_social_label[index] اختیاری رشته قابل دسترس هنگام: type = vcard
vcard_social_value[index] اختیاری رشته قابل دسترس هنگام: type = vcard
paypal
paypal_type اختیاری رشته مقادیر مجاز: buy_now, add_to_cart, donation (type=paypal)
paypal_email اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_title اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_currency اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_price اختیاری اعشاری قابل دسترس هنگام: type = paypal
paypal_thank_you_url اختیاری رشته قابل دسترس هنگام: type = paypal
paypal_cancel_url اختیاری رشته قابل دسترس هنگام: type = paypal
upi
upi_payee_id اختیاری رشته قابل دسترس هنگام: type = upi
upi_payee_name اختیاری رشته قابل دسترس هنگام: type = upi
upi_currency اختیاری رشته قابل دسترس هنگام: type = upi
upi_amount اختیاری اعشاری قابل دسترس هنگام: type = upi
upi_transaction_id اختیاری رشته قابل دسترس هنگام: type = upi
upi_transaction_note اختیاری رشته قابل دسترس هنگام: type = upi
upi_transaction_reference اختیاری رشته قابل دسترس هنگام: type = upi
upi_thank_you_url اختیاری رشته قابل دسترس هنگام: type = upi
epc
epc_iban اختیاری رشته قابل دسترس هنگام: type = epc
epc_payee_name اختیاری رشته قابل دسترس هنگام: type = epc
epc_currency اختیاری رشته قابل دسترس هنگام: type = epc
epc_amount اختیاری اعشاری قابل دسترس هنگام: type = epc
epc_bic اختیاری رشته قابل دسترس هنگام: type = epc
epc_remittance_reference اختیاری رشته قابل دسترس هنگام: type = epc
epc_remittance_text اختیاری رشته قابل دسترس هنگام: type = epc
information اختیاری رشته قابل دسترس هنگام: type = epc
pix
pix_payee_key اختیاری رشته قابل دسترس هنگام: type = pix
pix_payee_name اختیاری رشته قابل دسترس هنگام: type = pix
pix_currency اختیاری رشته قابل دسترس هنگام: type = pix
pix_amount اختیاری اعشاری قابل دسترس هنگام: type = pix
pix_city اختیاری رشته قابل دسترس هنگام: type = pix
pix_transaction_id اختیاری رشته قابل دسترس هنگام: type = pix
pix_description اختیاری رشته قابل دسترس هنگام: type = pix
curl --request POST \
--url 'https://tistos.com/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://tistos.com/api/qr-codes/{qr_code_id}
curl --request DELETE \
--url 'https://tistos.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \