لینکها
GET https://boof360.bio/api/links/
curl --request GET \
--url 'https://boof360.bio/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/links/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها | جزئیات | توصیف |
---|---|---|
page | اختیاری عدد صحیح | شماره صفحهای که میخواهید نتایج از آن بازیابی شوند. به صورت پیشفرض روی 1 تنظیم شده است.
|
results_per_page | اختیاری عدد صحیح | تعداد نتایج مورد نظر در هر صفحه. مقادیر مجاز: 10 , 25 , 50 , 100 , 250 , 500 , 1000 . به صورت پیشفرض روی 25 تنظیم شده است.
|
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://boof360.bio/api/links?&page=1",
"last": "https://boof360.bio/api/links?&page=1",
"next": null,
"prev": null,
"self": "https://boof360.bio/api/links?&page=1"
}
}
GET https://boof360.bio/api/links/{link_id}
curl --request GET \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
}
POST https://boof360.bio/api/links
پارامترها | جزئیات | توصیف |
---|---|---|
type | اختیاری رشته | link |
location_url | الزامی رشته | URL مقصد. |
url | اختیاری رشته | نام مستعار URL از لینک ایجاد شده. در صورت خالی گذاشتن، یک نام تصادفی تولید خواهد شد. |
domain_id | اختیاری عدد صحیح | - |
project_id | اختیاری عدد صحیح | - |
pixels_ids | اختیاری آرایه عدد صحیح | - |
schedule | اختیاری بولیان | - |
start_date | اختیاری رشته | در دسترس زمانی که: schedule = true |
end_date | اختیاری رشته | در دسترس زمانی که: schedule = true |
clicks_limit | اختیاری عدد صحیح | - |
expiration_url | اختیاری رشته | - |
sensitive_content | اختیاری بولیان | - |
http_status_code | اختیاری عدد صحیح | مقادیر مجاز: 301 , 302 , 307 , 308
|
app_linking_is_enabled | اختیاری بولیان | - |
cloaking_is_enabled | اختیاری بولیان | - |
cloaking_title | اختیاری رشته | - |
cloaking_favicon | اختیاری فایل | - |
password | اختیاری رشته | - |
forward_query_parameters_is_enabled | اختیاری بولیان | - |
utm_source | اختیاری missing_translation: api_documentation.strings | - |
utm_medium | اختیاری missing_translation: api_documentation.strings | - |
utm_campaign | اختیاری missing_translation: api_documentation.strings | - |
targeting_type | اختیاری رشته | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
targeting_continent_code_key[index] | اختیاری رشته | (targeting_type=continent_code) |
targeting_continent_code_value[index] | اختیاری رشته | (targeting_type=continent_code) |
targeting_country_code_key[index] | اختیاری رشته | (targeting_type=country_code) |
targeting_country_code_value[index] | اختیاری رشته | (targeting_type=country_code) |
targeting_device_type_key[index] | اختیاری رشته | (targeting_type=device_type) |
targeting_device_type_value[index] | اختیاری رشته | (targeting_type=device_type) |
targeting_browser_language_key[index] | اختیاری رشته | (targeting_type=browser_language) |
targeting_browser_language_value[index] | اختیاری رشته | (targeting_type=browser_language) |
targeting_rotation_key[index] | اختیاری رشته | (targeting_type=rotation) |
targeting_rotation_value[index] | اختیاری رشته | (targeting_type=rotation) |
targeting_os_name_key[index] | اختیاری رشته | (targeting_type=os_name) |
targeting_os_name_value[index] | اختیاری رشته | (targeting_type=os_name) |
targeting_browser_name_key[index] | اختیاری رشته | (targeting_type=browser_name) |
targeting_browser_name_value[index] | اختیاری رشته | (targeting_type=browser_name) |
curl --request POST \
--url 'https://boof360.bio/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://boof360.bio/' \
--url 'https://boof360.bio/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://boof360.bio/' \
{
"data": {
"id": 1
}
}
POST https://boof360.bio/api/links/{link_id}
پارامترها | جزئیات | توصیف |
---|---|---|
location_url | اختیاری رشته | URL مقصد. |
url | اختیاری رشته | نام مستعار URL از لینک ایجاد شده. در صورت خالی گذاشتن، یک نام تصادفی تولید خواهد شد. |
domain_id | اختیاری عدد صحیح | - |
project_id | اختیاری عدد صحیح | - |
pixels_ids | اختیاری آرایه عدد صحیح | - |
schedule | اختیاری بولیان | - |
start_date | اختیاری رشته | در دسترس زمانی که: schedule = true |
end_date | اختیاری رشته | در دسترس زمانی که: schedule = true |
clicks_limit | اختیاری عدد صحیح | - |
expiration_url | اختیاری رشته | - |
sensitive_content | اختیاری بولیان | - |
http_status_code | اختیاری عدد صحیح | مقادیر مجاز: 301 , 302 , 307 , 308
|
app_linking_is_enabled | اختیاری بولیان | - |
cloaking_is_enabled | اختیاری بولیان | - |
cloaking_title | اختیاری رشته | - |
cloaking_favicon | اختیاری فایل | - |
password | اختیاری رشته | - |
forward_query_parameters_is_enabled | اختیاری بولیان | - |
utm_source | اختیاری missing_translation: api_documentation.strings | - |
utm_medium | اختیاری missing_translation: api_documentation.strings | - |
utm_campaign | اختیاری missing_translation: api_documentation.strings | - |
targeting_type | اختیاری رشته | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
targeting_continent_code_key[index] | اختیاری رشته | (targeting_type=continent_code) |
targeting_continent_code_value[index] | اختیاری رشته | (targeting_type=continent_code) |
targeting_country_code_key[index] | اختیاری رشته | (targeting_type=country_code) |
targeting_country_code_value[index] | اختیاری رشته | (targeting_type=country_code) |
targeting_device_type_key[index] | اختیاری رشته | (targeting_type=device_type) |
targeting_device_type_value[index] | اختیاری رشته | (targeting_type=device_type) |
targeting_browser_language_key[index] | اختیاری رشته | (targeting_type=browser_language) |
targeting_browser_language_value[index] | اختیاری رشته | (targeting_type=browser_language) |
targeting_rotation_key[index] | اختیاری رشته | (targeting_type=rotation) |
targeting_rotation_value[index] | اختیاری رشته | (targeting_type=rotation) |
targeting_os_name_key[index] | اختیاری رشته | (targeting_type=os_name) |
targeting_os_name_value[index] | اختیاری رشته | (targeting_type=os_name) |
targeting_browser_name_key[index] | اختیاری رشته | (targeting_type=browser_name) |
targeting_browser_name_value[index] | اختیاری رشته | (targeting_type=browser_name) |
curl --request POST \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://boof360.bio/api/links/{link_id}
curl --request DELETE \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://boof360.bio/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \