Links

Notes
Expert level
Der API-Key sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. Erhalten Sie Ihren API-Schlüssel.
Liste

API endpoint:

GET 
https://4or.de/api/v1/links

Beispiel Request: 

curl --location --request GET 'https://4or.de/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Beschreibung
search
optional string
Search query.
search_by
optional string
Suche nach. Mögliche Werte sind: title für Title, alias für Alias, url für URL. Standardwert: title
status
optional integer
Status. Mögliche Werte sind: 0 für Alle, 1 für Aktiv, 2 für Abgelaufen, 3 für Deaktiviert. Standardwert: 0
space_id
optional integer
Space ID.
domain_id
optional integer
Domain ID.
pixel_id
optional integer
Pixel ID.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, clicks für Klicks, title für Title, alias für Alias, url für URL. Standardwert: id
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardwert: desc
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardwert: 100
anzeigen

API endpoint:

GET 
https://4or.de/api/v1/links/{id}

Beispiel Request: 

curl --location --request GET 'https://4or.de/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API endpoint:

POST 
https://4or.de/api/v1/links

Beispiel Request: 

curl --location --request POST 'https://4or.de/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parameter
Type
Beschreibung
url
erforderlich string
Destination URL.
domain_id
erforderlich integer
Domain ID.
alias
optional string
Alias.
space_id
optional integer
Space ID.
pixel_ids[]
optional array
Pixel IDs.
redirect_password
optional string
Redirect password.
sensitive_content
optional integer
Sensitive content. Mögliche Werte sind: 0 für Nein, 1 für Ja. Standardwert: 0
privacy
optional integer
Stats privacy. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardwert: 0
password
optional string
Stats password. Only works with privacy field set to 2.
active_period_start_at
optional string
Active period starting date in Y-m-d H:i format.
active_period_end_at
optional string
Active period ending date in Y-m-d H:i format.
clicks_limit
optional integer
Clicks limit.
expiration_url
optional string
Expiration URL.
targets_type
optional string
Targeting. Mögliche Werte sind: continents für Continents, countries für Countries, operating_systems für Operating systems, browsers für Browsers, languages für Languages, devices für Devices, rotations für Rotations.
targets[index][key]
optional string
For targets_type=country, the value must be in ISO 3166-1 alpha-2 format.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
For targets_type=browsers, the possible values are: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
For targets_type=devices, the possible values are: Desktop, Mobile, Tablet, Watch, Television.
For targets_type=languages, the value must be in ISO 639-1 alpha-2 format.
For targets_type=continents, the possible values are: AF für Africa, AN für Antarctica, AS für Asia, EU für Europe, NA für North America, OC für Oceania, SA für South America.
targets[index][value]
optional string
Destination URL.
Aktualisieren

API endpoint:

PUT PATCH 
https://4or.de/api/v1/links/{id}

Beispiel Request: 

curl --location --request PUT 'https://4or.de/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Beschreibung
url
optional string
Destination URL.
alias
optional string
Alias.
space_id
optional integer
Space ID.
pixel_ids[]
optional array
Pixel IDs.
redirect_password
optional string
Redirect password.
sensitive_content
optional integer
Sensitive content. Mögliche Werte sind: 0 für Nein, 1 für Ja.
privacy
optional integer
Stats privacy. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
password
optional string
Stats password. Only works with privacy field set to 2.
active_period_start_at
optional string
Active period starting date in Y-m-d H:i format.
active_period_end_at
optional string
Active period ending date in Y-m-d H:i format.
clicks_limit
optional integer
Clicks limit.
expiration_url
optional string
Expiration URL.
targets_type
optional string
Targeting. Mögliche Werte sind: continents für Continents, countries für Countries, operating_systems für Operating systems, browsers für Browsers, languages für Languages, devices für Devices, rotations für Rotations.
targets[index][key]
optional string
For targets_type=country, the value must be in ISO 3166-1 alpha-2 format.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
For targets_type=browsers, the possible values are: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
For targets_type=devices, the possible values are: Desktop, Mobile, Tablet, Watch, Television.
For targets_type=languages, the value must be in ISO 639-1 alpha-2 format.
For targets_type=continents, the possible values are: AF für Africa, AN für Antarctica, AS für Asia, EU für Europe, NA für North America, OC für Oceania, SA für South America.
targets[index][value]
optional string
Destination URL.
Löschen

API endpoint:

DELETE 
https://4or.de/api/v1/links/{id}

Beispiel Request: 

curl --location --request DELETE 'https://4or.de/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'