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
Die Suchanfrage.
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
Filtern nach 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
Filtern nach Space-ID.
domain_id
optional integer
Nach Domain-ID filtern.
pixel_id
optional integer
Filtern nach 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
Der Link der verkürzt werden soll.
domain_id
erforderlich integer
Die Domain-ID, unter der der Link gespeichert werden soll.
alias
optional string
Der Link-Alias.
password
optional string
Das Link-Passwort.
space_id
optional integer
Die Space-ID, unter der der Link gespeichert werden soll.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ob die Verknüpfung deaktiviert ist oder nicht. Mögliche Werte sind: 0 für Aktiv, 1 für Deaktiviert. Standardwert: 0
privacy
optional integer
Ob die Link-Statistiken öffentlich sind oder nicht. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardwert: 0
privacy_password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
expiration_url
optional string
Der Link, auf den der Benutzer weitergeleitet wird, wenn der Link abgelaufen ist.
expiration_date
optional string
Das Ablaufdatum des Links im Format YYYY-MM-DD.
expiration_time
optional string
Die Ablaufzeit des Links im Format HH:MM.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art des targeting. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Plattform, 4 für Rotation.
country[index][key]
optional string
Der Code des Ziellandes. Der Code muss in ISO 3166-1 alpha-2 standard sein.
country[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
platform[index][key]
optional string
Name der Zielplattform. Mögliche Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in ISO 639-1 alpha-2 standard sein.
language[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
rotation[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
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
Der Link der verkürzt werden soll.
alias
optional string
Der Link-Alias.
password
optional string
Das Link-Passwort.
space_id
optional integer
Die Space-ID, unter der der Link gespeichert werden soll.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ob die Verknüpfung deaktiviert ist oder nicht. Mögliche Werte sind: 0 für Aktiv, 1 für Deaktiviert.
privacy
optional integer
Ob die Link-Statistiken öffentlich sind oder nicht. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
privacy_password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
expiration_url
optional string
Der Link, auf den der Benutzer weitergeleitet wird, wenn der Link abgelaufen ist.
expiration_date
optional string
Das Ablaufdatum des Links im Format YYYY-MM-DD.
expiration_time
optional string
Die Ablaufzeit des Links im Format HH:MM.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art des targeting. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Plattform, 4 für Rotation.
country[index][key]
optional string
Der Code des Ziellandes. Der Code muss in ISO 3166-1 alpha-2 standard sein.
country[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
platform[index][key]
optional string
Name der Zielplattform. Mögliche Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in ISO 639-1 alpha-2 standard sein.
language[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
rotation[index][value]
optional string
Der Link, zu dem der Benutzer weitergeleitet wird.
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}'