Für Entwickler

API

Die API ist nur für registrierte Benutzer zugänglich. Sie authentifizieren sich mit einem API-Schlüssel, den du im Konto erstellst. Auf 30 Anfragen pro IP und Stunde begrenzt.

Authentifizierung

Sende den Schlüssel als Bearer-Token mit. Ohne gültigen Schlüssel antwortet die API mit 401.

Authorization: Bearer yk_…

Link erstellen

POST https://test.ykm.de/api/shorten

curl -X POST 'https://test.ykm.de/api/shorten' \
  -H 'Authorization: Bearer yk_DEIN_SCHLUESSEL' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example.com/sehr/lange/url",
    "alias": "demo",
    "public": true
  }'

Antwort 201 Created:

{
  "ok": true,
  "code": "demo",
  "short_url": "https://test.ykm.de/demo",
  "info_url": "https://test.ykm.de/info/demo"
}

Parameter

• url – Pflicht. Ziel-URL, http oder https.
• alias – optional. 3–32 Zeichen, a–z, 0–9, - und _.
• public – optional. true (Standard) listet den Link öffentlich.

Statistik abrufen

GET https://test.ykm.de/api/link/demo

curl -H 'Authorization: Bearer yk_DEIN_SCHLUESSEL' 'https://test.ykm.de/api/link/demo'

Die Antwort enthält Ziel, Klickzahl, Zeitstempel und – bei öffentlichen Links – die 7-Tage-Auswertung sowie die Top-Referrer.

Fehler

• 401 – Authentifizierung fehlt oder ist ungültig.
• 400 – ungültiges JSON.
• 409 – Alias bereits vergeben.
• 422 – URL oder Alias ungültig.
• 429 – Rate-Limit erreicht.

Hinweis

Über die API erstellte Links werden deinem Konto zugeordnet und erscheinen in „Meine Links“. Wenn du die API im Browser mit angemeldeter Session aufrufst, genügt die Session als Authentifizierung.