Links

Authentifizierung

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}'

Parameters

Name

Type

Beschreibung

search

optional string

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

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}'

Parameters

Name

Type

Beschreibung

url

erforderlich string

Ziel-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

Weiterleitungs-Passwort.

sensitive_content

optional integer

Sensibler Inhalt. Mögliche Werte sind: 0 für Nein, 1 für Ja. Standardwert: 0

privacy

optional integer

Statistik-Privatsphäre. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardwert: 0

password

optional string

Statistik-Passwort. Funktioniert nur, wenn privacy auf 2 gesetzt ist.

active_period_start_at

optional string

Startdatum des aktiven Zeitraums im Format Y-m-dTH:i:s.

active_period_end_at

optional string

Enddatum des aktiven Zeitraums im Format Y-m-dTH:i:s.

clicks_limit

optional integer

Klicks-Limit.

expiration_url

optional string

Ablauf-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

Für targets_type=country muss der Wert im Format ISO 3166-1 alpha-2 sein.

Für targets_type=operating_systems sind die möglichen Werte: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Für targets_type=browsers sind die möglichen Werte: 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.

Für targets_type=devices sind die möglichen Werte: Desktop, Mobile, Tablet, Watch, Television.

Für targets_type=languages muss der Wert im Format ISO 639-1 alpha-2 sein.

Für targets_type=continents sind die möglichen Werte: 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

Ziel-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}'

Parameters

Name

Type

Beschreibung

url

optional string

Ziel-URL.

alias

optional string

Alias.

space_id

optional integer

Space-ID.

pixel_ids[]

optional array

Pixel-IDs.

redirect_password

optional string

Weiterleitungs-Passwort.

sensitive_content

optional integer

Sensibler Inhalt. Mögliche Werte sind: 0 für Nein, 1 für Ja.

privacy

optional integer

Statistik-Privatsphäre. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.

password

optional string

Statistik-Passwort. Funktioniert nur, wenn privacy auf 2 gesetzt ist.

active_period_start_at

optional string

Startdatum des aktiven Zeitraums im Format Y-m-dTH:i:s.

active_period_end_at

optional string

Enddatum des aktiven Zeitraums im Format Y-m-dTH:i:s.

clicks_limit

optional integer

Klicks-Limit.

expiration_url

optional string

Ablauf-URL.

targets_type

optional string

targets[index][key]

optional string

Für targets_type=country muss der Wert im Format ISO 3166-1 alpha-2 sein.

Für targets_type=operating_systems sind die möglichen Werte: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Für targets_type=devices sind die möglichen Werte: Desktop, Mobile, Tablet, Watch, Television.

Für targets_type=languages muss der Wert im Format ISO 639-1 alpha-2 sein.

targets[index][value]

optional string

Ziel-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}'