Entwicklerdokumentation

2w1.link API

v1

Erzeuge über eine einfache HTTP-Schnittstelle Kurzlinks für öffentliche Webseiten und erhalte den neuen Slug als JSON-Antwort.

APIKEY beantragen
Version 1.0 GET · JSON

Schnellstart

Kurzlink erstellen

GET

Sende die vollständige öffentliche Ziel-URL als URL-kodierten Query-Parameter. Der APIKEY gehört ausschließlich in den Authorization-Header.

GET https://2w1.link/api/v1/shorten?url=https%3A%2F%2Fexample.com%2Fpfad
Authorization: Bearer DEIN_APIKEY

Zugang

Authentifizierung

Jeder API-Aufruf benötigt einen aktiven APIKEY. Sende ihn als Authorization: Bearer <APIKEY>; dadurch erscheint er weder in der URL noch in deren Query-Parametern.

APIKEY geheim halten

Verwende den APIKEY ausschließlich in serverseitigen Anwendungen oder in einer Secret-Verwaltung. Niemals im Frontend, in Dokumentationen oder in URLs.

Aufruf

Parameter

Parameter Ort Beschreibung
APIKEY Authorization Aktiver APIKEY als Bearer-APIKEY.
url Query · Pflicht Vollständige öffentliche Ziel-URL; genau einmal URL-kodiert.

Kodiere die komplette Ziel-URL einschließlich Pfad, Query-Parametern und Sonderzeichen. Beim Codebeispiel übernimmt die verwendete Bibliothek diese Kodierung.

Integration

Codebeispiele

Terminal
curl --request GET \
  --url 'https://2w1.link/api/v1/shorten?url=https%3A%2F%2Fexample.com%2Fpfad' \
  --header 'Authorization: Bearer DEIN_APIKEY'

Antwort

Ergebnis und Statuscodes

200 OK Erfolgreiche Erstellung
{
  "slug": "a1b2c3"
}

Der zurückgegebene Slug bildet die Kurzlink-Adresse https://2w1.link/{slug}.

400

Ungültige AnfrageAnfrage oder Ziel-URL fehlt bzw. ist ungültig.

401

APIKEY ungültigDer APIKEY wurde nicht gefunden.

403

APIKEY deaktiviertDer APIKEY ist nicht aktiv.

405

Methode nicht erlaubtDie API akzeptiert ausschließlich GET.

410

URL deaktiviertFür die Ziel-URL existiert ein deaktivierter Link.

429

Limit erreichtDas Tageskontingent des APIKEY ist ausgeschöpft.

503

Dienst nicht verfügbarAPIKEY-Prüfung oder Linkerstellung ist vorübergehend nicht möglich.