Links

Notizen
Expertenlevel
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. API-Schlüssel anfordern.
Liste

API endpoint:

GET 
http://jetzt.work/api/v1/links

Beispiel für eine Anfrage: 

curl --location --request GET 'http://jetzt.work/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Suchabfrage.
search_by
optional string
Suche nach. Mögliche Werte: title für Titel, alias für Alias, url für URL. Standartmäßig: title.
status
optional integer
Filtern nach Status. Mögliche Werte: 0 für Alle, 1 für Aktiv, 2 für Abgelaufen, 3 für Gesperrt. Standartmäßig: 0.
space
optional integer
Filtern nach Gruppen-ID.
domain
optional integer
Filtern nach Domain-ID.
pixel
optional integer
Filtern nach Pixel-ID.
sort_by
optional string
Sortieren nach. Mögliche Werte: id für Erstelldatum, clicks für Klicks, title für Titel, alias für Alias, url für URL. Standartmäßig: id.
sort
optional string
Art. Mögliche Werte: desc für Absteigend, asc für Aufsteigend. Standartmäßig: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte: 10, 25, 50, 100. Standartmäßig: 10.
Anzeigen

API endpoint:

GET 
http://jetzt.work/api/v1/links/{id}

Beispiel für eine Anfrage: 

curl --location --request GET 'http://jetzt.work/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API endpoint:

POST 
http://jetzt.work/api/v1/links

Beispiel für eine Anfrage: 

curl --location --request POST 'http://jetzt.work/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
Typ
Beschreibung
url
erforderlich string
Der zu verkürzende Link.
domain
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
optional integer
Die Gruppen-ID, unter der der Link gespeichert werden soll.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ist der Link deaktiviert oder nicht. Mögliche Werte: 0 für Aktiv, 1 für Gesperrt. Standartmäßig: 0.
privacy
optional integer
Sind die Link Statistiken Öffentlich oder nicht. Mögliche Werte: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standartmäßig: 0.
privacy_password
optional string
Das Passwort für die Statistik-Seite. Funktioniert nur wenn privacy nach 2 gesetzt ist.
expiration_url
optional string
Der Link, an den der Nutzer nach Ablauf der Gültigkeit des Links weitergeleitet wird.
expiration_date
optional string
Das Ablaufdatum des Links in YYYY-MM-DD format.
expiration_time
optional string
Die Ablaufzeit des Links in HH:MM format.
expiration_clicks
optional integer
Die Anzahl der Links nachdem der Link ablaufen sollte.
target_type
optional integer
Die Art der Zielsetzung. Mögliche Werte: 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.
country[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
platform[index][key]
optional string
Der Name der Zielplattform. Mögliche Werte: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
rotation[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
Update

API endpoint:

PUT PATCH 
http://jetzt.work/api/v1/links/{id}

Beispiel für eine Anfrage: 

curl --location --request PUT 'http://jetzt.work/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Typ
Beschreibung
url
optional string
Der zu verkürzende Link.
alias
optional string
Der Link-Alias.
password
optional string
Das Link-Passwort.
space
optional integer
Die Gruppen-ID, unter der der Link gespeichert werden soll.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ist der Link deaktiviert oder nicht. Mögliche Werte: 0 für Aktiv, 1 für Gesperrt.
privacy
optional integer
Sind die Link Statistiken Öffentlich oder nicht. Mögliche Werte: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
privacy_password
optional string
Das Passwort für die Statistik-Seite. Funktioniert nur wenn privacy nach 2 gesetzt ist.
expiration_url
optional string
Der Link, an den der Nutzer nach Ablauf der Gültigkeit des Links weitergeleitet wird.
expiration_date
optional string
Das Ablaufdatum des Links in YYYY-MM-DD format.
expiration_time
optional string
Die Ablaufzeit des Links in HH:MM format.
expiration_clicks
optional integer
Die Anzahl der Links nachdem der Link ablaufen sollte.
target_type
optional integer
Die Art der Zielsetzung. Mögliche Werte: 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.
country[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
platform[index][key]
optional string
Der Name der Zielplattform. Mögliche Werte: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
rotation[index][value]
optional string
Der Link zudem der Benutzer weitergeleitet wird.
Löschen

API endpoint:

DELETE 
http://jetzt.work/api/v1/links/{id}

Beispiel für eine Anfrage: 

curl --location --request DELETE 'http://jetzt.work/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'