Liens
GET https://www.your.bzh/api/links/
curl --request GET \
--url 'https://www.your.bzh/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/api/links/' \
--header 'Authorization: Bearer {api_key}' \
| Paramètres | Détails | Description |
|---|---|---|
| page | Optionnel Entier | Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut 1. |
| results_per_page | Optionnel Entier | Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut, 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://www.your.bzh/api/links?&page=1",
"last": "https://www.your.bzh/api/links?&page=1",
"next": null,
"prev": null,
"self": "https://www.your.bzh/api/links?&page=1"
}
}
GET https://www.your.bzh/api/links/{link_id}
curl --request GET \
--url 'https://www.your.bzh/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/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://www.your.bzh/api/links
| Paramètres | Détails | Description |
|---|---|---|
| type | Optionnel Chaîne | link |
| location_url | Requis Chaîne | L'URL de la destination. |
| url | Optionnel Chaîne | L'alias d'URL du lien généré. Laissez vide pour en générer un aléatoirement. |
| domain_id | Optionnel Entier | - |
| project_id | Optionnel Entier | - |
| pixels_ids | Optionnel Tableau Entier | - |
| schedule | Optionnel Booléen | - |
| start_date | Optionnel Chaîne | Disponible lorsque : schedule = true |
| end_date | Optionnel Chaîne | Disponible lorsque : schedule = true |
| clicks_limit | Optionnel Entier | - |
| expiration_url | Optionnel Chaîne | - |
| sensitive_content | Optionnel Booléen | - |
| http_status_code | Optionnel Entier | Valeurs autorisées : 301, 302, 307, 308 |
| app_linking_is_enabled | Optionnel Booléen | - |
| cloaking_is_enabled | Optionnel Booléen | - |
| cloaking_title | Optionnel Chaîne | - |
| cloaking_favicon | Optionnel Fichier | - |
| cloaking_opengraph | Optionnel Fichier | - |
| password | Optionnel Chaîne | - |
| forward_query_parameters_is_enabled | Optionnel Booléen | - |
| utm_source | Optionnel missing_translation: api_documentation.strings | - |
| utm_medium | Optionnel missing_translation: api_documentation.strings | - |
| utm_campaign | Optionnel missing_translation: api_documentation.strings | - |
| targeting_type | Optionnel Chaîne | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | Optionnel Chaîne | (targeting_type=continent_code) |
| targeting_continent_code_value[index] | Optionnel Chaîne | (targeting_type=continent_code) |
| targeting_country_code_key[index] | Optionnel Chaîne | (targeting_type=country_code) |
| targeting_country_code_value[index] | Optionnel Chaîne | (targeting_type=country_code) |
| targeting_city_name_key[index] | Optionnel Chaîne | (targeting_type=city_name) |
| targeting_city_name_value[index] | Optionnel Chaîne | (targeting_type=city_name) |
| targeting_device_type_key[index] | Optionnel Chaîne | (targeting_type=device_type) |
| targeting_device_type_value[index] | Optionnel Chaîne | (targeting_type=device_type) |
| targeting_browser_language_key[index] | Optionnel Chaîne | (targeting_type=browser_language) |
| targeting_browser_language_value[index] | Optionnel Chaîne | (targeting_type=browser_language) |
| targeting_rotation_key[index] | Optionnel Chaîne | (targeting_type=rotation) |
| targeting_rotation_value[index] | Optionnel Chaîne | (targeting_type=rotation) |
| targeting_os_name_key[index] | Optionnel Chaîne | (targeting_type=os_name) |
| targeting_os_name_value[index] | Optionnel Chaîne | (targeting_type=os_name) |
| targeting_browser_name_key[index] | Optionnel Chaîne | (targeting_type=browser_name) |
| targeting_browser_name_value[index] | Optionnel Chaîne | (targeting_type=browser_name) |
curl --request POST \
--url 'https://www.your.bzh/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://www.your.bzh/' \
--url 'https://www.your.bzh/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://www.your.bzh/' \
{
"data": {
"id": 1
}
}
POST https://www.your.bzh/api/links/{link_id}
| Paramètres | Détails | Description |
|---|---|---|
| location_url | Optionnel Chaîne | L'URL de la destination. |
| url | Optionnel Chaîne | L'alias d'URL du lien généré. Laissez vide pour en générer un aléatoirement. |
| domain_id | Optionnel Entier | - |
| project_id | Optionnel Entier | - |
| pixels_ids | Optionnel Tableau Entier | - |
| schedule | Optionnel Booléen | - |
| start_date | Optionnel Chaîne | Disponible lorsque : schedule = true |
| end_date | Optionnel Chaîne | Disponible lorsque : schedule = true |
| clicks_limit | Optionnel Entier | - |
| expiration_url | Optionnel Chaîne | - |
| sensitive_content | Optionnel Booléen | - |
| http_status_code | Optionnel Entier | Valeurs autorisées : 301, 302, 307, 308 |
| app_linking_is_enabled | Optionnel Booléen | - |
| cloaking_is_enabled | Optionnel Booléen | - |
| cloaking_title | Optionnel Chaîne | - |
| cloaking_favicon | Optionnel Fichier | - |
| cloaking_opengraph | Optionnel Fichier | - |
| password | Optionnel Chaîne | - |
| forward_query_parameters_is_enabled | Optionnel Booléen | - |
| utm_source | Optionnel missing_translation: api_documentation.strings | - |
| utm_medium | Optionnel missing_translation: api_documentation.strings | - |
| utm_campaign | Optionnel missing_translation: api_documentation.strings | - |
| targeting_type | Optionnel Chaîne | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | Optionnel Chaîne | (targeting_type=continent_code) |
| targeting_continent_code_value[index] | Optionnel Chaîne | (targeting_type=continent_code) |
| targeting_country_code_key[index] | Optionnel Chaîne | (targeting_type=country_code) |
| targeting_country_code_value[index] | Optionnel Chaîne | (targeting_type=country_code) |
| targeting_city_name_key[index] | Optionnel Chaîne | (targeting_type=city_name) |
| targeting_city_name_value[index] | Optionnel Chaîne | (targeting_type=city_name) |
| targeting_device_type_key[index] | Optionnel Chaîne | (targeting_type=device_type) |
| targeting_device_type_value[index] | Optionnel Chaîne | (targeting_type=device_type) |
| targeting_browser_language_key[index] | Optionnel Chaîne | (targeting_type=browser_language) |
| targeting_browser_language_value[index] | Optionnel Chaîne | (targeting_type=browser_language) |
| targeting_rotation_key[index] | Optionnel Chaîne | (targeting_type=rotation) |
| targeting_rotation_value[index] | Optionnel Chaîne | (targeting_type=rotation) |
| targeting_os_name_key[index] | Optionnel Chaîne | (targeting_type=os_name) |
| targeting_os_name_value[index] | Optionnel Chaîne | (targeting_type=os_name) |
| targeting_browser_name_key[index] | Optionnel Chaîne | (targeting_type=browser_name) |
| targeting_browser_name_value[index] | Optionnel Chaîne | (targeting_type=browser_name) |
curl --request POST \
--url 'https://www.your.bzh/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://www.your.bzh/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://www.your.bzh/api/links/{link_id}
curl --request DELETE \
--url 'https://www.your.bzh/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.your.bzh/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \