روابط
GET https://codeqr.ma/api/links/
curl --request GET \
--url 'https://codeqr.ma/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://codeqr.ma/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,
"datetime": "2025-12-20 22:04:32",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://codeqr.ma/api/links?page=1",
"last": "https://codeqr.ma/api/links?page=1",
"next": null,
"prev": null,
"self": "https://codeqr.ma/api/links?page=1"
}
}
GET https://codeqr.ma/api/links/{link_id}
curl --request GET \
--url 'https://codeqr.ma/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://codeqr.ma/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": "2025-12-20 22:04:32",
}
}
POST https://codeqr.ma/api/links
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| type | اختياري سلسلة نصية | link |
| location_url | مطلوب سلسلة نصية | عنوان URL الوجهة.متاح عند: is_bulk = 0 |
| location_urls | مطلوب سلسلة نصية | عنوان URL الوجهة.متاح عند: is_bulk = 1 |
| url | اختياري سلسلة نصية | الاسم البديل لعنوان URL للرابط المولد. اتركه فارغاً لتوليده عشوائياً.متاح عند: is_bulk = 0 |
| is_bulk | اختياري قيمة منطقية | |
| domain_id | اختياري رقم صحيح | - |
| project_id | اختياري رقم صحيح | - |
| pixels_ids | اختياري مصفوفة رقم صحيح | - |
| email_reports | اختياري مصفوفة | Notification handler 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_meta_description | اختياري سلسلة نصية | - |
| cloaking_custom_js | اختياري سلسلة نصية | - |
| cloaking_favicon | اختياري ملف | - |
| cloaking_opengraph | اختياري ملف | - |
| password | اختياري سلسلة نصية | - |
| forward_query_parameters_is_enabled | اختياري قيمة منطقية | - |
| utm_source | اختياري سلسلة نصية | - |
| utm_medium | اختياري سلسلة نصية | - |
| utm_campaign | اختياري سلسلة نصية | - |
| 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_city_name_key[index] | اختياري سلسلة نصية | متاح عند: targeting_type = city_name |
| targeting_city_name_value[index] | اختياري سلسلة نصية | متاح عند: targeting_type = city_name |
| 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://codeqr.ma/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://codeqr.ma/' \
--url 'https://codeqr.ma/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://codeqr.ma/' \
{
"data": {
"id": 1
}
}
POST https://codeqr.ma/api/links/{link_id}
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| location_url | اختياري سلسلة نصية | عنوان URL الوجهة. |
| url | اختياري سلسلة نصية | الاسم البديل لعنوان URL للرابط المولد. اتركه فارغاً لتوليده عشوائياً. |
| domain_id | اختياري رقم صحيح | - |
| project_id | اختياري رقم صحيح | - |
| pixels_ids | اختياري مصفوفة رقم صحيح | - |
| email_reports | اختياري مصفوفة | Notification handler 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_meta_description | اختياري سلسلة نصية | - |
| cloaking_custom_js | اختياري سلسلة نصية | - |
| cloaking_favicon | اختياري ملف | - |
| cloaking_opengraph | اختياري ملف | - |
| password | اختياري سلسلة نصية | - |
| forward_query_parameters_is_enabled | اختياري قيمة منطقية | - |
| utm_source | اختياري سلسلة نصية | - |
| utm_medium | اختياري سلسلة نصية | - |
| utm_campaign | اختياري سلسلة نصية | - |
| 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_city_name_key[index] | اختياري سلسلة نصية | متاح عند: targeting_type = city_name |
| targeting_city_name_value[index] | اختياري سلسلة نصية | متاح عند: targeting_type = city_name |
| 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://codeqr.ma/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://codeqr.ma/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://codeqr.ma/api/links/{link_id}
curl --request DELETE \
--url 'https://codeqr.ma/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://codeqr.ma/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \