الروابط
GET https://oo.om/api/links/
curl --request GET \
--url 'https://oo.om/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://oo.om/api/links/' \
--header 'Authorization: Bearer {api_key}' \
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| search | اختياري نص (String) | سلسلة البحث. |
| search_by | اختياري نص (String) | الحقل الذي تبحث من خلاله. القيم المسموح بها هي: url, location_url. |
| is_enabled | اختياري منطقي (Boolean) | |
| domain_id | اختياري عدد صحيح (Integer) | |
| type | اختياري نص (String) |
biolink, link, file, vcard, event, static |
| datetime_field | اختياري نص (String) | القيم المسموح بها: datetime, last_datetime |
| datetime_start | اختياري نص (String) | تصفية النتائج بدءاً من هذا التاريخ والوقت. بتنسيق Y-m-d H:i:s. |
| datetime_end | اختياري نص (String) | تصفية النتائج حتى هذا التاريخ والوقت. بتنسيق Y-m-d H:i:s. |
| order_by | اختياري نص (String) | الحقل الذي سيتم ترتيب النتائج بناءً عليه. القيم المسموح بها هي: link_id, datetime, last_datetime, clicks, url. |
| order_type | اختياري نص (String) | طريقة ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي، وDESC للترتيب التنازلي. |
| page | اختياري عدد صحيح (Integer) | رقم الصفحة التي تريد الحصول على النتائج منها. القيمة الافتراضية هي 1. |
| results_per_page | اختياري عدد صحيح (Integer) | عدد النتائج المطلوبة في الصفحة الواحدة. القيم المسموح بها هي: 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,
"datetime": "2026-05-21 11:14:48",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://oo.om/api/links?page=1",
"last": "https://oo.om/api/links?page=1",
"next": null,
"prev": null,
"self": "https://oo.om/api/links?page=1"
}
}
GET https://oo.om/api/links/{link_id}
curl --request GET \
--url 'https://oo.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://oo.om/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,
"datetime": "2026-05-21 11:14:48",
}
}
POST https://oo.om/api/links
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| type | اختياري نص (String) | link |
| location_url | مطلوب نص (String) | رابط الوجهة (Destination URL).متاح عندما: is_bulk = 0 |
| location_urls | مطلوب نص (String) | رابط الوجهة (Destination URL).متاح عندما: is_bulk = 1 |
| url | اختياري نص (String) | الاسم المستعار (Alias) للرابط الذي تم إنشاؤه. اتركه فارغاً لتوليد اسم عشوائي.متاح عندما: is_bulk = 0 |
| is_bulk | اختياري منطقي (Boolean) | |
| domain_id | اختياري عدد صحيح (Integer) | - |
| project_id | اختياري عدد صحيح (Integer) | - |
| pixels_ids | اختياري مصفوفة عدد صحيح (Integer) | - |
| email_reports | اختياري مصفوفة | معرفات معالجات الإشعارات |
| schedule | اختياري منطقي (Boolean) | - |
| start_date | اختياري نص (String) | متاح عندما: schedule = true |
| end_date | اختياري نص (String) | متاح عندما: schedule = true |
| clicks_limit | اختياري عدد صحيح (Integer) | - |
| expiration_url | اختياري نص (String) | - |
| sensitive_content | اختياري منطقي (Boolean) | - |
| http_status_code | اختياري عدد صحيح (Integer) | القيم المسموح بها: 301, 302, 307, 308 |
| app_linking_is_enabled | اختياري منطقي (Boolean) | - |
| cloaking_is_enabled | اختياري منطقي (Boolean) | - |
| cloaking_title | اختياري نص (String) | - |
| cloaking_meta_description | اختياري نص (String) | - |
| cloaking_custom_js | اختياري نص (String) | - |
| cloaking_favicon | اختياري ملف | - |
| cloaking_opengraph | اختياري ملف | - |
| password | اختياري نص (String) | - |
| forward_query_parameters_is_enabled | اختياري منطقي (Boolean) | - |
| seo_block | اختياري منطقي (Boolean) | - |
| utm_source | اختياري نص (String) | - |
| utm_medium | اختياري نص (String) | - |
| utm_campaign | اختياري نص (String) | - |
| targeting_type | اختياري نص (String) | continent_code, country_code, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] | اختياري نص (String) | متاح عندما: targeting_type = continent_code |
| targeting_continent_code_value[index] | اختياري نص (String) | متاح عندما: targeting_type = continent_code |
| targeting_country_code_key[index] | اختياري نص (String) | متاح عندما: targeting_type = country_code |
| targeting_country_code_value[index] | اختياري نص (String) | متاح عندما: targeting_type = country_code |
| targeting_city_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = city_name |
| targeting_city_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = city_name |
| targeting_device_type_key[index] | اختياري نص (String) | متاح عندما: targeting_type = device_type |
| targeting_device_type_value[index] | اختياري نص (String) | متاح عندما: targeting_type = device_type |
| targeting_browser_language_key[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_language |
| targeting_browser_language_value[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_language |
| targeting_rotation_key[index] | اختياري نص (String) | متاح عندما: targeting_type = rotation |
| targeting_rotation_value[index] | اختياري نص (String) | متاح عندما: targeting_type = rotation |
| targeting_os_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = os_name |
| targeting_os_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = os_name |
| targeting_browser_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_name |
| targeting_browser_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_name |
curl --request POST \
--url 'https://oo.om/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://oo.om/' \
--url 'https://oo.om/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://oo.om/' \
{
"data": {
"id": 1
}
}
POST https://oo.om/api/links/{link_id}
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| location_url | اختياري نص (String) | رابط الوجهة (Destination URL). |
| url | اختياري نص (String) | الاسم المستعار (Alias) للرابط الذي تم إنشاؤه. اتركه فارغاً لتوليد اسم عشوائي. |
| domain_id | اختياري عدد صحيح (Integer) | - |
| project_id | اختياري عدد صحيح (Integer) | - |
| pixels_ids | اختياري مصفوفة عدد صحيح (Integer) | - |
| email_reports | اختياري مصفوفة | معرفات معالجات الإشعارات |
| schedule | اختياري منطقي (Boolean) | - |
| start_date | اختياري نص (String) | متاح عندما: schedule = true |
| end_date | اختياري نص (String) | متاح عندما: schedule = true |
| clicks_limit | اختياري عدد صحيح (Integer) | - |
| expiration_url | اختياري نص (String) | - |
| sensitive_content | اختياري منطقي (Boolean) | - |
| http_status_code | اختياري عدد صحيح (Integer) | القيم المسموح بها: 301, 302, 307, 308 |
| app_linking_is_enabled | اختياري منطقي (Boolean) | - |
| cloaking_is_enabled | اختياري منطقي (Boolean) | - |
| cloaking_title | اختياري نص (String) | - |
| cloaking_meta_description | اختياري نص (String) | - |
| cloaking_custom_js | اختياري نص (String) | - |
| cloaking_favicon | اختياري ملف | - |
| cloaking_opengraph | اختياري ملف | - |
| password | اختياري نص (String) | - |
| forward_query_parameters_is_enabled | اختياري منطقي (Boolean) | - |
| seo_block | اختياري منطقي (Boolean) | - |
| utm_source | اختياري نص (String) | - |
| utm_medium | اختياري نص (String) | - |
| utm_campaign | اختياري نص (String) | - |
| targeting_type | اختياري نص (String) | continent_code, country_code, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] | اختياري نص (String) | متاح عندما: targeting_type = continent_code |
| targeting_continent_code_value[index] | اختياري نص (String) | متاح عندما: targeting_type = continent_code |
| targeting_country_code_key[index] | اختياري نص (String) | متاح عندما: targeting_type = country_code |
| targeting_country_code_value[index] | اختياري نص (String) | متاح عندما: targeting_type = country_code |
| targeting_city_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = city_name |
| targeting_city_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = city_name |
| targeting_device_type_key[index] | اختياري نص (String) | متاح عندما: targeting_type = device_type |
| targeting_device_type_value[index] | اختياري نص (String) | متاح عندما: targeting_type = device_type |
| targeting_browser_language_key[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_language |
| targeting_browser_language_value[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_language |
| targeting_rotation_key[index] | اختياري نص (String) | متاح عندما: targeting_type = rotation |
| targeting_rotation_value[index] | اختياري نص (String) | متاح عندما: targeting_type = rotation |
| targeting_os_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = os_name |
| targeting_os_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = os_name |
| targeting_browser_name_key[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_name |
| targeting_browser_name_value[index] | اختياري نص (String) | متاح عندما: targeting_type = browser_name |
curl --request POST \
--url 'https://oo.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://oo.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://oo.om/api/links/{link_id}
curl --request DELETE \
--url 'https://oo.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://oo.om/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \