Links

Anmerkungen
Experten level
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. Bekomme dein API Schlüssel.
Liste

API endpunkt:

GET 
https://link.kroginski.de/api/v1/links

Beispiel anfordern: 

curl --location --request GET 'https://link.kroginski.de/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
by
optional string
Suche nach. Mögliche Werte sind: title für Title, alias für Alias, url für URL. Stadard zu: title.
status
optional integer
Nach Status filtern. Mögliche Werte sind: 0 für Alles, 1 für Aktiviert, 2 für Abgelaufen, 3 für Deaktiviert. Stadard zu: 0.
space
optional integer
Filter nach Speicher-ID.
domain
optional integer
Nach Domain-ID Filtern.
pixel
optional integer
Nach Pixel-ID FIltern.
sort
optional string
Sortieren. Mögliche Werte sind: desc für absteigend, asc für Aufsteigend, max für Beste Leistung, min für Am wenigsten leistungsfähig. Stadard zu: desc.
per_page
optional int
Ergebnisse pro Seite. Mögliche Werte sind: 10 zu 100. Stadard zu: 10.
Zeige

API endpunkt:

GET 
https://link.kroginski.de/api/v1/links/{id}

Beispiel anfordern: 

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

API endpunkt:

POST 
https://link.kroginski.de/api/v1/links

Beispiel anfordern: 

curl --location --request POST 'https://link.kroginski.de/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Typ
Beschreibung
url
benötigt string
Der zu kürzende Link.
alias
optional string
Der Link Alias.
password
optional string
Das Link Passwort.
space
optional integer
Die Raum-ID, unter dem der Link gespeichert werden soll.
domain
optional integer
Die Domain-ID, unter der der Link gespeichert werden soll.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ob der Link deaktiviert ist oder nicht. Mögliche Werte sind: 0 für Aktiviert, 1 für Deaktiviert. Stadard zu: 0.
privacy
optional integer
Link Statistiken öffentlich zugänglich machen oder nicht. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Stadard zu: 0.
privacy_password
optional string
Passwort für die Statistiken Seite. funktioniert nur wenn privacy zu 2 gesetzt ist.
expiration_url
optional string
Der Link, an den der Benutzer weitergeleitet wird, sobald der Link abgelaufen ist.
expiration_date
optional string
Das Ablaufdatum des Links im YYYY-MM-DD format.
expiration_time
optional string
Die Link-Ablaufzeit im HH:MM format.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art der Ausrichtung. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Platform, 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
Der 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.
Update

API endpunkt:

PUT PATCH 
https://link.kroginski.de/api/v1/links/{id}

Beispiel anfordern: 

curl --location --request PUT 'https://link.kroginski.de/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 kürzende Link.
alias
optional string
Der Link Alias.
password
optional string
Das Link Passwort.
space
optional integer
Die Raum-ID, unter dem der Link gespeichert werden soll.
domain
optional integer
Die Domain-ID, unter der der Link gespeichert werden soll.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Ob der Link deaktiviert ist oder nicht. Mögliche Werte sind: 0 für Aktiviert, 1 für Deaktiviert.
privacy
optional integer
Link Statistiken öffentlich zugänglich machen oder nicht. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
privacy_password
optional string
Passwort für die Statistiken Seite. funktioniert nur wenn privacy zu 2 gesetzt ist.
expiration_url
optional string
Der Link, an den der Benutzer weitergeleitet wird, sobald der Link abgelaufen ist.
expiration_date
optional string
Das Ablaufdatum des Links im YYYY-MM-DD format.
expiration_time
optional string
Die Link-Ablaufzeit im HH:MM format.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art der Ausrichtung. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Platform, 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
Der 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 endpunkt:

DELETE 
https://link.kroginski.de/links/{id}/destroy

Beispiel anfordern: 

curl --location --request DELETE 'https://link.kroginski.de/links/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'