Links - API-Dokumentation

Alle abrufen

Endpunkt

GET https://www.clientlink.ch/api/links/

Beispiel

curl --request GET \
--url 'https://www.clientlink.ch/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parameter	Details	Beschreibung
page	Optional Ganzzahl	Die Seitennummer, ab der Sie Ergebnisse wünschen. Der Standardwert ist `1`.
results_per_page	Optional Ganzzahl	Wie viele Ergebnisse Sie pro Seite wünschen. Erlaubte Werte sind: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standardwert ist `25`.

Beispiel für eine Antwort

{ "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-04-30 15:02:51" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://www.clientlink.ch/api/links?&page=1", "last": "https://www.clientlink.ch/api/links?&page=1", "next": null, "prev": null, "self": "https://www.clientlink.ch/api/links?&page=1" } }

Einen abrufen

Endpunkt

GET https://www.clientlink.ch/api/links/{link_id}

Beispiel

curl --request GET \
--url 'https://www.clientlink.ch/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Beispiel für eine Antwort

{ "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-04-30 15:02:51" } }

Hinzufügen

Endpunkt

POST https://www.clientlink.ch/api/links

Parameter	Details	Beschreibung
type	Optional Zeichenfolge	`link`
location_url	Erforderlich Zeichenfolge	Die URL des Ziels.
url	Optional Zeichenfolge	Der URL-Alias des generierten Links. Leer lassen für einen zufällig generierten Link.
domain_id	Optional Ganzzahl	-
project_id	Optional Ganzzahl	-
pixels_ids	Optional Array Ganzzahl	-
schedule	Optional Boolesche	-
start_date	Optional Zeichenfolge	Verfügbar, wenn: schedule = true
end_date	Optional Zeichenfolge	Verfügbar, wenn: schedule = true
clicks_limit	Optional Ganzzahl	-
expiration_url	Optional Zeichenfolge	-
sensitive_content	Optional Boolesche	-
http_status_code	Optional Ganzzahl	Erlaubte Werte: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional Boolesche	-
cloaking_is_enabled	Optional Boolesche	-
cloaking_title	Optional Zeichenfolge	-
cloaking_custom_js	Optional Zeichenfolge	-
cloaking_favicon	Optional Datei	-
cloaking_opengraph	Optional Datei	-
password	Optional Zeichenfolge	-
forward_query_parameters_is_enabled	Optional Boolesche	-
utm_source	Optional Zeichenfolge	-
utm_medium	Optional Zeichenfolge	-
utm_campaign	Optional Zeichenfolge	-
targeting_type	Optional Zeichenfolge	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = continent_code
targeting_continent_code_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = continent_code
targeting_country_code_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = country_code
targeting_country_code_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = country_code
targeting_city_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = city_name
targeting_city_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = city_name
targeting_device_type_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = device_type
targeting_device_type_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = device_type
targeting_browser_language_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_language
targeting_browser_language_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_language
targeting_rotation_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = rotation
targeting_rotation_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = rotation
targeting_os_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = os_name
targeting_os_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = os_name
targeting_browser_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_name
targeting_browser_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_name

Beispiel

curl --request POST \
--url 'https://www.clientlink.ch/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://www.clientlink.ch/' \

Beispiel für eine Antwort

{ "data": { "id": 1 "url": "3jgdlt6upr", "host": "clnk.ch", "scheme": "https://" } }

Aktualisieren

Endpunkt

POST https://www.clientlink.ch/api/links/{link_id}

Parameter	Details	Beschreibung
location_url	Optional Zeichenfolge	Die URL des Ziels.
url	Optional Zeichenfolge	Der URL-Alias des generierten Links. Leer lassen für einen zufällig generierten Link.
domain_id	Optional Ganzzahl	-
project_id	Optional Ganzzahl	-
pixels_ids	Optional Array Ganzzahl	-
schedule	Optional Boolesche	-
start_date	Optional Zeichenfolge	Verfügbar, wenn: schedule = true
end_date	Optional Zeichenfolge	Verfügbar, wenn: schedule = true
clicks_limit	Optional Ganzzahl	-
expiration_url	Optional Zeichenfolge	-
sensitive_content	Optional Boolesche	-
http_status_code	Optional Ganzzahl	Erlaubte Werte: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional Boolesche	-
cloaking_is_enabled	Optional Boolesche	-
cloaking_title	Optional Zeichenfolge	-
cloaking_custom_js	Optional Zeichenfolge	-
cloaking_favicon	Optional Datei	-
cloaking_opengraph	Optional Datei	-
password	Optional Zeichenfolge	-
forward_query_parameters_is_enabled	Optional Boolesche	-
utm_source	Optional Zeichenfolge	-
utm_medium	Optional Zeichenfolge	-
utm_campaign	Optional Zeichenfolge	-
targeting_type	Optional Zeichenfolge	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = continent_code
targeting_continent_code_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = continent_code
targeting_country_code_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = country_code
targeting_country_code_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = country_code
targeting_city_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = city_name
targeting_city_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = city_name
targeting_device_type_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = device_type
targeting_device_type_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = device_type
targeting_browser_language_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_language
targeting_browser_language_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_language
targeting_rotation_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = rotation
targeting_rotation_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = rotation
targeting_os_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = os_name
targeting_os_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = os_name
targeting_browser_name_key[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_name
targeting_browser_name_value[index]	Optional Zeichenfolge	Verfügbar, wenn: targeting_type = browser_name

Beispiel

curl --request POST \
--url 'https://www.clientlink.ch/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Beispiel für eine Antwort

{ "data": { "id": 1 "url": "3jgdlt6upr", "host": "clnk.ch", "scheme": "https://" } }

Löschen

Endpunkt

DELETE https://www.clientlink.ch/api/links/{link_id}

Beispiel

curl --request DELETE \
--url 'https://www.clientlink.ch/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \