API-Dokumentation

Links direkt aus Ihrem Code kürzen. Ein Endpunkt, ein Bearer-Token.

Endpunkt

POSThttps://za.gl/api/shorten

RESTJSON-BodyBearer-Auth

Authentifizierung

Übergeben Sie Ihren API-Token im Header Authorization als Bearer-Token. Sie finden ihn im Dashboard Ihres Kontos, sobald Sie Ihren ersten Link erstellt haben.

Header

Authorization: Bearer YOUR_API_TOKEN

Noch kein Token? Sie können den Endpunkt auch ohne aufrufen. Za.gl legt spontan ein anonymes Konto an und liefert einen frischen Token in data.newAuthToken. zurück. Speichern Sie ihn, um Ihre Links später zu verwalten.

Request-Body

Feld	Typ	Beschreibung
`originalUrl`erforderlich	string	Die lange URL, die gekürzt werden soll. Ohne Protokoll wird https:// automatisch ergänzt.
`customAlias`	string	Ihre eigene Endung, z. B. za.gl/mein-link. Muss eindeutig sein, sonst kommt ein 409 zurück.
`password`	string	Schützt den Link, Besucher brauchen ein Passwort, um weiterzukommen.
`expiresAt`	string (ISO date)	Wann der Link nicht mehr funktionieren soll. Muss in der Zukunft liegen.
`expiresInMinutes / expiresInHours / expiresInDays`	number	Alternative zu expiresAt, Ablauf nach einer relativen Zeitspanne.
`waitTimer`	number (0-300)	Sekunden, die der Besucher auf der Vorschauseite bis zur Weiterleitung wartet.
`customGtmId`	string	Ihre eigene Google Tag Manager ID (GTM-XXXXXXX), die auf der Vorschauseite ausgelöst wird.
`title / description`	string	Optionale Metadaten, die zum Link gespeichert werden.
`generateQR`	boolean	Gibt zusätzlich einen QR-Code für die Kurz-URL zurück.

originalUrlerforderlich

string

Die lange URL, die gekürzt werden soll. Ohne Protokoll wird https:// automatisch ergänzt.

customAlias

string

Ihre eigene Endung, z. B. za.gl/mein-link. Muss eindeutig sein, sonst kommt ein 409 zurück.

password

string

Schützt den Link, Besucher brauchen ein Passwort, um weiterzukommen.

expiresAt

string (ISO date)

Wann der Link nicht mehr funktionieren soll. Muss in der Zukunft liegen.

expiresInMinutes / expiresInHours / expiresInDays

number

Alternative zu expiresAt, Ablauf nach einer relativen Zeitspanne.

waitTimer

number (0-300)

Sekunden, die der Besucher auf der Vorschauseite bis zur Weiterleitung wartet.

customGtmId

string

Ihre eigene Google Tag Manager ID (GTM-XXXXXXX), die auf der Vorschauseite ausgelöst wird.

title / description

string

Optionale Metadaten, die zum Link gespeichert werden.

generateQR

boolean

Gibt zusätzlich einen QR-Code für die Kurz-URL zurück.

Beispiel-Request

POSTcURL

curl -X POST https://za.gl/api/shorten \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "password": "optional-secret",
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "waitTimer": 5
  }'

Beispiel-Response

Ein erfolgreicher Aufruf liefert 200 OK mit der Kurz-URL in data.shortUrl.

200 OKJSON

{
  "success": true,
  "message": "URL shortened successfully",
  "data": {
    "id": "123",
    "alias": "my-link",
    "shortUrl": "https://za.gl/my-link",
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "domain": "za.gl",
    "title": "",
    "description": null,
    "hasPassword": true,
    "isActive": true,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "hits": 0,
    "waitTimer": 5,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:00.000Z",
    "authToken": "your-account-token"
  }
}

Rate-Limits und Fehler

10 req/minBis zu 10 Anfragen pro Minute und Client.

409Der gewünschte Alias ist bereits vergeben.

400Ungültige URL oder ein Ablaufdatum in der Vergangenheit.

429Sie haben das Rate-Limit oder Ihr Monatskontingent erreicht.