کدهای QR
GET https://oovo.ir/api/qr-codes/
curl --request GET \
--url 'https://oovo.ir/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \
--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 . پیشفرض 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}' \
--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 , crypto , vcard , paypal |
foreground_type | اختیاری String | color , gradient |
foreground_color | اختیاری String | (foreground_type=color) |
foreground_gradient_style | اختیاری String | vertical horizontal diagonal inverse_diagonal radial (foreground_type=gradient) |
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 |
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) |
اختیاری String | (type=email) | |
email_subject | اختیاری String | (type=email) |
email_body | اختیاری String | (type=email) |
اختیاری String | (type=whatsapp) | |
facetime | اختیاری String | (type=facetime) |
location_latitude | اختیاری Float | (type=location) |
location_longitude | اختیاری Float | (type=location) |
wifi_ssid | اختیاری String | (type=wifi) |
wifi_encryption | اختیاری String | nopass , WEP , WPA/WPA2 (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_coin | اختیاری String | (type=crypto) |
crypto_address | اختیاری String | (type=crypto) |
crypto_amount | اختیاری String | (type=crypto) |
vcard_first_name | اختیاری String | (type=vcard) |
vcard_last_name | اختیاری String | (type=vcard) |
vcard_phone | اختیاری 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) |
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!' \
--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 , crypto , vcard , paypal |
foreground_type | اختیاری String | color , gradient |
foreground_color | اختیاری String | (foreground_type=color) |
foreground_gradient_style | اختیاری String | vertical horizontal diagonal inverse_diagonal radial (foreground_type=gradient) |
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 |
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) |
اختیاری String | (type=email) | |
email_subject | اختیاری String | (type=email) |
email_body | اختیاری String | (type=email) |
اختیاری String | (type=whatsapp) | |
facetime | اختیاری String | (type=facetime) |
location_latitude | اختیاری Float | (type=location) |
location_longitude | اختیاری Float | (type=location) |
wifi_ssid | اختیاری String | (type=wifi) |
wifi_encryption | اختیاری String | nopass , WEP , WPA/WPA2 (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_coin | اختیاری String | (type=crypto) |
crypto_address | اختیاری String | (type=crypto) |
crypto_amount | اختیاری String | (type=crypto) |
vcard_first_name | اختیاری String | (type=vcard) |
vcard_last_name | اختیاری String | (type=vcard) |
vcard_phone | اختیاری 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) |
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' \
--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}' \
--url 'https://oovo.ir/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \