Überblick
Erstellen Sie Kurzlinks, Uploads, Statistiken und Bezahlzugänge mit der URLZ-API. Diese Referenz trennt Serverintegrationen per API-Schlüssel von authentifizierten Kontositzungen.
Server-zu-Server
Aktiven Schlüssel im Backend, in Automatisierungen oder internen Tools verwenden.
apikey=YOUR_API_KEYKontositzung
Bearer für Kontolinks, Uploads, Statistiken und Monetarisierung verwenden.
Authorization: Bearer …Schnellstart
Erstellen Sie in drei Schritten den ersten Kurzlink und nutzen Sie danach die vollständige Referenz.
- 1Konto erstellen
Dashboard öffnen und API-Tarif aktivieren.
- 2API-Schlüssel kopieren
Nur auf dem Server speichern, nie in öffentlichem Code.
- 3Anfrage senden
Ziel senden und result.short_url aus der JSON-Antwort lesen.
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/private-report"
// Server-side JavaScript (Node.js)
const body = new URLSearchParams({
apikey: 'YOUR_API_KEY',
fullUrl: 'https://example.com/private-report'
});
const response = await fetch('https://api.urlz.li/url/create', {
method: 'POST',
body
});
const data = await response.json();
console.log(data.result.short_url);
$request = curl_init('https://api.urlz.li/url/create');
curl_setopt_array($request, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query([
'apikey' => 'YOUR_API_KEY',
'fullUrl' => 'https://example.com/private-report',
]),
CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($request), true, 512, JSON_THROW_ON_ERROR);
echo $data['result']['short_url'];
import requests
response = requests.post(
"https://api.urlz.li/url/create",
data={
"apikey": "YOUR_API_KEY",
"fullUrl": "https://example.com/private-report",
},
timeout=15,
)
response.raise_for_status()
print(response.json()["result"]["short_url"])
Authentifizierung
URLZ unterstützt zwei Authentifizierungsarten. Wählen Sie die passende.
API-Schlüssel
Für Backends. apikey in URL oder Formular senden; Schlüssel und Abo müssen aktiv sein.
apikey=YOUR_API_KEYBearer-Sitzung
Für Kontofunktionen. Token beim Login beziehen und im Authorization-Header senden.
Authorization: Bearer SESSION_TOKENSchlüssel, Passwörter und Tokens nie in JavaScript, Logs, Versionskontrolle oder öffentlichen Repositories veröffentlichen.
Endpunktübersicht
Endpunkt auswählen, um Parameter und Beispiele zu sehen.
/url/createKurzlink erstellen
GET/url/listLinks auflisten und filtern
POST/mobile/v1/auth/login.phpKontositzung öffnen
POST/mobile/v1/shorten.phpKontolink erstellen
POST/mobile/v1/upload.phpDatei oder Foto hochladen
GET/mobile/v1/links.phpKontolinks auflisten
GET/mobile/v1/clicks.phpKlickstatistiken lesen
DELETE/mobile/v1/delete-link.phpLink löschen
POST/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
GET/mobile/v1/collaboration/chats.phpList link conversations
GET/mobile/v1/collaboration/requests.phpTrack document requests
POST/mobile/v1/monetization/links.phpBezahllink erstellen oder umwandeln
POST/mobile/v1/monetization/upload.phpBezahlte Datei oder Foto erstellen
GET/mobile/v1/monetization/links.phpBezahllinks auflisten
GET/mobile/v1/monetization/transactions.phpVerkäufe auflisten
API-Schlüssel-Endpunkte
Stabile Serverrouten zum Erstellen und Suchen von Kurzlinks.
/url/createKurzlink erstellen
Erstellt Kurz-URL mit aktivem Schlüssel.
apikeyParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
apikey | string | Ja | — |
fullUrl | URL | Ja | — |
encrypt | string | Nein | "" |
password | string | Nein | "" |
curl -X POST "https://api.urlz.li/url/create" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "fullUrl=https://example.com/report.pdf"
{
"result": {
"short_url": "https://urlz.li/7b3c2e5a",
"hash": "7b3c2e5a",
"date": "2026-11-02",
"time": "14:32:10"
}
}
/url/listLinks auflisten und filtern
Liefert Links mit Filtern und Seitennavigation.
apikeyParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
apikey | string | Ja | — |
limit | integer (1–1000) | Nein | 100 |
offset | integer | Nein | 0 |
order | asc | desc | Nein | desc |
date | YYYY-MM-DD | Nein | — |
from_date | YYYY-MM-DD | Nein | — |
to_date | YYYY-MM-DD | Nein | — |
url_destination | string | Nein | — |
hash | string | Nein | — |
curl -G "https://api.urlz.li/url/list" \
--data-urlencode "apikey=YOUR_API_KEY" \
--data-urlencode "limit=25" \
--data-urlencode "order=desc"
{
"result": {
"filters": { "limit": 25, "offset": 0, "order": "desc" },
"total": 42,
"count": 25,
"items": [
{
"id": 1204,
"date": "2026-11-02",
"time": "14:32:10",
"destination": "https://example.com/report.pdf",
"hash": "7b3c2e5a",
"hash_retour": "https://urlz.li/7b3c2e5a"
}
]
}
}
Konto-Endpunkte
Kontolinks, Uploads, Klicks und Löschung.
/mobile/v1/auth/login.phpKontositzung öffnen
Tauscht Zugangsdaten gegen Bearer-Token.
Keine AuthentifizierungParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
email | Ja | — | |
password | string | Ja | — |
curl -X POST "https://api.urlz.li/mobile/v1/auth/login.php" \
-H "Content-Type: application/json" \
-d '{"email":"developer@example.com","password":"YOUR_PASSWORD"}'
{
"token": "SESSION_TOKEN",
"user": {
"id": 42,
"email": "developer@example.com",
"apiKey": "ACCOUNT_API_KEY",
"planActive": true
}
}
/mobile/v1/shorten.phpKontolink erstellen
Erstellt normalen oder geschützten Link; Bearer ist außer bei Passwort optional.
Optionales Bearer-TokenParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
url | URL | Ja | — |
password | string (min. 4) | Nein | — |
curl -X POST "https://api.urlz.li/mobile/v1/shorten.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/private","password":"safe-pass"}'
{
"shortUrl": "https://urlz.li/Ab3dE91x",
"destination": "https://example.com/private",
"hash": "Ab3dE91x",
"protected": true
}
/mobile/v1/upload.phpDatei oder Foto hochladen
Lädt erlaubte Datei bis 10 MB hoch.
Optionales Bearer-TokenParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
file | multipart file | Ja | — |
kind | photo | document | Nein | document |
password | string (min. 4) | Nein | — |
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./photo.jpg" \
-F "kind=photo"
{
"shortUrl": "https://urlz.li/P8kLm21q",
"destination": "https://urlz.li/cloud/app/photo_….jpg",
"hash": "P8kLm21q",
"protected": false
}
/mobile/v1/links.phpKontolinks auflisten
Listet Links, Klicks, Schutz und Monetarisierung.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
limit | integer (1–100) | Nein | 100 |
offset | integer | Nein | 0 |
curl "https://api.urlz.li/mobile/v1/links.php?limit=25&offset=0" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 1204,
"shortUrl": "https://urlz.li/7b3c2e5a",
"destination": "https://example.com/report.pdf",
"protected": false,
"monetized": true,
"clicks": 18
}
],
"total": 42,
"summary": { "totalLinks": 42, "totalClicks": 304, "clicksLast7Days": 28 }
}
/mobile/v1/clicks.phpKlickstatistiken lesen
Liefert Klicks, Besucher, Länder und Zugriffe.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
linkId | integer | Ja | — |
limit | integer (1–100) | Nein | 100 |
offset | integer | Nein | 0 |
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"link": { "id": 1204, "shortUrl": "https://urlz.li/7b3c2e5a" },
"summary": {
"totalClicks": 18,
"uniqueVisitors": 14,
"clicksLast24Hours": 2,
"clicksLast7Days": 9
},
"countries": [{ "country": "France", "countryCode": "FR", "clicks": 8 }],
"items": []
}
/mobile/v1/delete-link.phpLink löschen
Löscht nur Links des authentifizierten Kontos.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
hash | string | Ja | — |
curl -X DELETE "https://api.urlz.li/mobile/v1/delete-link.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a"}'
{
"ok": true,
"message": "Link deleted."
}
URLZ Chat & Request
Add private conversations, collect requested documents, schedule reminders and track submissions.
/mobile/v1/collaboration/configure.phpEnable URLZ Chat or URLZ Request
Attach a private conversation and/or a document request to an existing account link. A Bearer session token or API key is accepted.
Bearer or API keyParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
hash | string | Ja | — |
chat.enabled | boolean | Nein | false |
request.enabled | boolean | Nein | false |
request.title | string | Nein | — |
request.items | string[] | Nein | [] |
request.recipients | email[] | Nein | [] |
request.deadline | ISO datetime | Nein | — |
request.paymentRequired | boolean | Nein | false |
curl -X POST "https://api.urlz.li/mobile/v1/collaboration/configure.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"hash":"7b3c2e5a","chat":{"enabled":true},"request":{"enabled":true,"title":"Accounting documents","items":["Invoices","Bank statement"]}}'
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
/mobile/v1/collaboration/chats.phpList link conversations
Return chat-enabled links and message totals. Add id to retrieve messages.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
id | integer | Nein | — |
after | integer | Nein | 0 |
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
/mobile/v1/collaboration/requests.phpTrack document requests
List requests, expected items, recipients, submissions and secure files. Add id for full detail.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
id | integer | Nein | — |
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
-H "Authorization: Bearer SESSION_TOKEN"
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
Bezahllink-Endpunkte
Bezahlzugänge erstellen und Verkäufe abrufen.
/mobile/v1/monetization/links.phpBezahllink erstellen oder umwandeln
Erstellt Bezahl-URL oder wandelt bestehenden Link um.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
destination | URL | Nein | — |
existingLinkId | integer | Nein | — |
title | string (max. 180) | Ja | — |
description | string (max. 3000) | Nein | — |
price | decimal | Ja | — |
currency | EUR | USD | Ja | USD |
accessPolicy | permanent | timed | limited | Nein | permanent |
accessDurationHours | integer (1–8760) | Nein | 24 |
maxAccesses | integer (1–1000) | Nein | 1 |
locale | ISO 639-1 | Nein | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"destination":"https://example.com/private-course",
"title":"Private course access",
"description":"One-time access to the course.",
"price":"9.90",
"currency":"EUR",
"accessPolicy":"permanent",
"locale":"en"
}'
{
"id": 91,
"hash": "cd3ed9a4",
"shortUrl": "https://urlz.li/cd3ed9a4",
"paywallUrl": "https://urlz.li/en/pay/cd3ed9a4/",
"converted": false
}
/mobile/v1/monetization/upload.phpBezahlte Datei oder Foto erstellen
Speichert Datei privat und erstellt Bezahllink, maximal 50 MB.
BearerParameter
| Parameter | Typ | Erforderlich | Standard |
|---|---|---|---|
file | multipart file | Ja | — |
kind | photo | file | Nein | file |
title | string (max. 180) | Ja | — |
description | string (max. 3000) | Nein | — |
price | decimal | Ja | — |
currency | EUR | USD | Ja | USD |
accessPolicy | permanent | timed | limited | Nein | permanent |
locale | ISO 639-1 | Nein | en |
curl -X POST "https://api.urlz.li/mobile/v1/monetization/upload.php" \
-H "Authorization: Bearer SESSION_TOKEN" \
-F "file=@./premium-photo.jpg" \
-F "kind=photo" \
-F "title=Premium event photo" \
-F "price=4.90" \
-F "currency=EUR"
{
"id": 92,
"hash": "e71f8a20",
"shortUrl": "https://urlz.li/e71f8a20",
"paywallUrl": "https://urlz.li/en/pay/e71f8a20/"
}
/mobile/v1/monetization/links.phpBezahllinks auflisten
Liefert Bezahllinks, Verkäufe, Brutto, Netto und Status.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/links.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"id": 91,
"shortUrl": "https://urlz.li/cd3ed9a4",
"kind": "url",
"priceMinor": 990,
"currency": "EUR",
"status": "active",
"sales": 4,
"grossMinor": 3960,
"netMinor": 3374
}
]
}
/mobile/v1/monetization/transactions.phpVerkäufe auflisten
Liefert Bestellungen, Gebühren, Netto und Freigabedaten.
Bearercurl "https://api.urlz.li/mobile/v1/monetization/transactions.php" \
-H "Authorization: Bearer SESSION_TOKEN"
{
"items": [
{
"orderNumber": "LNK-20261102-8F3C21",
"grossMinor": 990,
"platformFeeMinor": 69,
"processorFeeMinor": 45,
"netMinor": 876,
"currency": "EUR",
"status": "paid",
"fundsAvailableAt": "2026-11-16 14:32:10",
"fundsStatus": "held"
}
]
}
Fehler und HTTP-Codes
Moderne Endpunkte liefern message, API-Schlüssel-Routen error. Verwenden Sie immer den HTTP-Status.
{ "message": "A valid link is required." }{ "error": "Invalid API key" }Anfrage abgeschlossen.
Link oder Datei erstellt.
JSON oder Syntax ungültig.
Token fehlt oder ist abgelaufen.
Schlüssel, Tarif oder Konto nicht berechtigt.
Ressource existiert nicht.
Status steht im Konflikt.
Felder fehlen oder sind ungültig.
Verlangsamen und später erneut versuchen.
Später idempotent wiederholen.
Sicherheit und Limits
Wenden Sie diese Regeln in Produktion an.
- Verwenden Sie ausschließlich HTTPS.
- Halten Sie API-Schlüssel geheim und erneuern Sie sie regelmäßig.
- Prüfen und kodieren Sie Benutzereingaben.
- Nutzen Sie Paginierung für Listen und Protokolle.
- Empfohlenes Maximum: 10 Anfragen pro Sekunde und Schlüssel.
Senden Sie Endpunkt, HTTP-Status und ein bereinigtes Beispiel ohne Zugangsdaten.
