ENTWICKLERREFERENZ

URLZ.li API-Dokumentation

Authentifizierung, Kurzlinks, Datei- und Foto-Uploads, Klickstatistiken und Bezahllink-APIs mit sofort nutzbaren Beispielen.

01

Ü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_KEY

Kontositzung

Bearer für Kontolinks, Uploads, Statistiken und Monetarisierung verwenden.

Authorization: Bearer …
02

Schnellstart

Erstellen Sie in drei Schritten den ersten Kurzlink und nutzen Sie danach die vollständige Referenz.

  1. 1
    Konto erstellen

    Dashboard öffnen und API-Tarif aktivieren.

  2. 2
    API-Schlüssel kopieren

    Nur auf dem Server speichern, nie in öffentlichem Code.

  3. 3
    Anfrage senden

    Ziel senden und result.short_url aus der JSON-Antwort lesen.

Curl
curl -X POST "https://api.urlz.li/url/create" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  --data-urlencode "fullUrl=https://example.com/private-report"
03

Authentifizierung

URLZ unterstützt zwei Authentifizierungsarten. Wählen Sie die passende.

A

API-Schlüssel

Für Backends. apikey in URL oder Formular senden; Schlüssel und Abo müssen aktiv sein.

apikey=YOUR_API_KEY
B

Bearer-Sitzung

Für Kontofunktionen. Token beim Login beziehen und im Authorization-Header senden.

Authorization: Bearer SESSION_TOKEN
Zugangsdaten serverseitig schützen

Schlüssel, Passwörter und Tokens nie in JavaScript, Logs, Versionskontrolle oder öffentlichen Repositories veröffentlichen.

04

Endpunktübersicht

Endpunkt auswählen, um Parameter und Beispiele zu sehen.

05

API-Schlüssel-Endpunkte

Stabile Serverrouten zum Erstellen und Suchen von Kurzlinks.

06

Konto-Endpunkte

Kontolinks, Uploads, Klicks und Löschung.

POST/mobile/v1/auth/login.php

Kontositzung öffnen

Tauscht Zugangsdaten gegen Bearer-Token.

Keine Authentifizierung

Parameter

ParameterTypErforderlichStandard
emailemailJa—
passwordstringJa—
Anfrage
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"}'
Antwort
{
  "token": "SESSION_TOKEN",
  "user": {
    "id": 42,
    "email": "developer@example.com",
    "apiKey": "ACCOUNT_API_KEY",
    "planActive": true
  }
}
POST/mobile/v1/shorten.php

Kontolink erstellen

Erstellt normalen oder geschützten Link; Bearer ist außer bei Passwort optional.

Optionales Bearer-Token

Parameter

ParameterTypErforderlichStandard
urlURLJa—
passwordstring (min. 4)Nein—
Anfrage
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"}'
Antwort
{
  "shortUrl": "https://urlz.li/Ab3dE91x",
  "destination": "https://example.com/private",
  "hash": "Ab3dE91x",
  "protected": true
}
POST/mobile/v1/upload.php

Datei oder Foto hochladen

Lädt erlaubte Datei bis 10 MB hoch.

Optionales Bearer-Token

Parameter

ParameterTypErforderlichStandard
filemultipart fileJa—
kindphoto | documentNeindocument
passwordstring (min. 4)Nein—
Anfrage
curl -X POST "https://api.urlz.li/mobile/v1/upload.php" \
  -H "Authorization: Bearer SESSION_TOKEN" \
  -F "file=@./photo.jpg" \
  -F "kind=photo"
Antwort
{
  "shortUrl": "https://urlz.li/P8kLm21q",
  "destination": "https://urlz.li/cloud/app/photo_….jpg",
  "hash": "P8kLm21q",
  "protected": false
}
GET/mobile/v1/clicks.php

Klickstatistiken lesen

Liefert Klicks, Besucher, Länder und Zugriffe.

Bearer

Parameter

ParameterTypErforderlichStandard
linkIdintegerJa—
limitinteger (1–100)Nein100
offsetintegerNein0
Anfrage
curl "https://api.urlz.li/mobile/v1/clicks.php?linkId=1204&limit=25" \
  -H "Authorization: Bearer SESSION_TOKEN"
Antwort
{
  "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": []
}
07

URLZ Chat & Request

Add private conversations, collect requested documents, schedule reminders and track submissions.

POST/mobile/v1/collaboration/configure.php

Enable 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 key

Parameter

ParameterTypErforderlichStandard
hashstringJa—
chat.enabledbooleanNeinfalse
request.enabledbooleanNeinfalse
request.titlestringNein—
request.itemsstring[]Nein[]
request.recipientsemail[]Nein[]
request.deadlineISO datetimeNein—
request.paymentRequiredbooleanNeinfalse
Anfrage
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"]}}'
Antwort
{"featureId":14,"hash":"7b3c2e5a","chatEnabled":true,"requestEnabled":true}
GET/mobile/v1/collaboration/chats.php

List link conversations

Return chat-enabled links and message totals. Add id to retrieve messages.

Bearer

Parameter

ParameterTypErforderlichStandard
idintegerNein—
afterintegerNein0
Anfrage
curl "https://api.urlz.li/mobile/v1/collaboration/chats.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Antwort
{"items":[{"id":14,"hash":"7b3c2e5a","messageCount":3,"messages":[]}]}
GET/mobile/v1/collaboration/requests.php

Track document requests

List requests, expected items, recipients, submissions and secure files. Add id for full detail.

Bearer

Parameter

ParameterTypErforderlichStandard
idintegerNein—
Anfrage
curl "https://api.urlz.li/mobile/v1/collaboration/requests.php?id=14" \
  -H "Authorization: Bearer SESSION_TOKEN"
Antwort
{"items":[{"id":14,"title":"Accounting documents","recipients":1,"submissions":1,"files":2}]}
08

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" }
200
Erfolg

Anfrage abgeschlossen.

201
Erstellt

Link oder Datei erstellt.

400
Ungültige Anfrage

JSON oder Syntax ungültig.

401
Anmeldung erforderlich

Token fehlt oder ist abgelaufen.

403
Verboten

Schlüssel, Tarif oder Konto nicht berechtigt.

404
Nicht gefunden

Ressource existiert nicht.

409
Konflikt

Status steht im Konflikt.

422
Validierung fehlgeschlagen

Felder fehlen oder sind ungültig.

429
Zu viele Anfragen

Verlangsamen und später erneut versuchen.

500/503
Server nicht verfügbar

Später idempotent wiederholen.

09

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.
Hilfe benötigt?

Senden Sie Endpunkt, HTTP-Status und ein bereinigtes Beispiel ohne Zugangsdaten.

URLZ FÜR iPHONE

Die neue iOS-Version ist fast da

Die aktualisierte URLZ-App für iPhone wird gerade fertiggestellt und erscheint in den nächsten Tagen im App Store. Vielen Dank für Ihre Geduld.