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.
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
curl --request GET \
--url 'https://2w1.link/api/v1/shorten?url=https%3A%2F%2Fexample.com%2Fpfad' \
--header 'Authorization: Bearer DEIN_APIKEY'
const apiKey = process.env.TWOWONE_APIKEY;
const targetUrl = 'https://example.com/pfad';
const endpoint = 'https://2w1.link/api/v1/shorten?url='
+ encodeURIComponent(targetUrl);
const response = await fetch(endpoint, {
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer ' + apiKey
}
});
const data = await response.json();
if (!response.ok) {
throw new Error(data.msg || 'API-Fehler');
}
console.log('https://2w1.link/' + data.slug);
$apiKey = 'DEIN_APIKEY';
$targetUrl = 'https://example.com/pfad';
$endpoint = 'https://2w1.link/api/v1/shorten?url='
. rawurlencode($targetUrl);
$context = stream_context_create([
'http' => [
'method' => 'GET',
'header' => "Accept: application/json\r\n"
. 'Authorization: Bearer ' . $apiKey . "\r\n",
'ignore_errors' => true
]
]);
$response = file_get_contents($endpoint, false, $context);
$data = json_decode($response, true);
echo 'https://2w1.link/' . $data['slug'];
Antwort
Ergebnis und Statuscodes
{
"slug": "a1b2c3"
}
Der zurückgegebene Slug bildet die Kurzlink-Adresse https://2w1.link/{slug}.
Ungültige AnfrageAnfrage oder Ziel-URL fehlt bzw. ist ungültig.
APIKEY ungültigDer APIKEY wurde nicht gefunden.
APIKEY deaktiviertDer APIKEY ist nicht aktiv.
Methode nicht erlaubtDie API akzeptiert ausschließlich GET.
URL deaktiviertFür die Ziel-URL existiert ein deaktivierter Link.
Limit erreichtDas Tageskontingent des APIKEY ist ausgeschöpft.
Dienst nicht verfügbarAPIKEY-Prüfung oder Linkerstellung ist vorübergehend nicht möglich.