API-Referenz

Alle öffentlichen Endpunkte laufen über das Gateway unter /api/v1/links – diese Seite ist öffentlich; zum Senden echter Anfragen nutzen Sie den API-Tester in der Konsole.

Endpunkte: 45 Endpunkte
Gruppen: 5 Gruppen
Scopes: 5 Scopes
Methoden: GET 20; POST 8; PATCH 9; DELETE 8

OpenAPI API-Tester Schlüssel erstellen

Links

7 Endpunkte

Lebenszyklus von Link- und Route-Graph-Ressourcen.

Listet Links mit Cursor-Paginierung und Filtern auf.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Erstellt einen Link in Kurzform (url) oder mit vollständigem Route-Graph.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Gibt einen Ihnen gehörenden Link samt Route-Graph zurück.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Aktualisiert Metadaten, Routing und den Route-Graph.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht den Link und die zugehörigen Graph-Ressourcen.
cURLLink
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Schreibgeschützter Plattform-/Gerätekatalog.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/platform-catalog" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Prüft, ob ein Slug frei ist; akzeptiert optional domainId und excludeLinkId für das Umbenennen.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/links/slug-availability" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Routes

17 Endpunkte

Targeting-Bedingungen, Ziele und Eigenschaften.

Gibt die Route-Liste eines Links zurück.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Fügt eine neue Route hinzu.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Gibt eine einzelne Route eines Links anhand der routeId zurück.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Aktualisiert eine Route.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht eine Route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Listet Route-Bedingungen auf (COUNTRY, DEVICE_PROFILE, OS, USER_AGENT, LANGUAGE, REFERRER_DOMAIN).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Fügt eine Bedingung hinzu (Auflistung per GET; PATCH/DELETE /:conditionId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Aktualisiert eine Route-Bedingung teilweise.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht eine Route-Bedingung dauerhaft.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Listet die Zieleinträge einer Route auf (Tree- oder Board-Einträge).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Verknüpft ein Katalogziel (Auflistung per GET; PATCH/DELETE /:itemId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Aktualisiert ein Route-Ziel (z. B. dessen Pflicht-Flag).

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Trennt ein Ziel dauerhaft von der Route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Listet Route-Eigenschaften auf: PASSWORD, EXPIRATION_DATE, LIMIT, UTM, REDIRECT_DELAY.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Fügt eine Eigenschaft hinzu (Auflistung per GET; PATCH/DELETE /:featureId).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Aktualisiert das enabled-Flag oder die config einer Route-Eigenschaft.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Entfernt eine Eigenschaft dauerhaft von der Route.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Trees, Boards und Ordner

15 Endpunkte

Link-Sammlungen. POST erstellt, PATCH/DELETE /:id aktualisiert und löscht.

Listet Ihre Tree-Ressourcen auf.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/trees" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Erstellt einen Link-in-Bio-Tree; username ist erforderlich (3–64 Buchstaben, Ziffern oder Bindestriche).

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/trees" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Gibt einen einzelnen Link-in-Bio-Tree anhand der id zurück.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Aktualisiert einen Tree teilweise; senden Sie nur die geänderten Felder.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht einen Tree dauerhaft.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Listet Ihre Board-Ressourcen auf.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/boards" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Erstellt ein Board; title und slug sind erforderlich, layout ist optional.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/boards" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Gibt ein einzelnes Board anhand der id zurück.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Aktualisiert ein Board teilweise; senden Sie nur die geänderten Felder.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht ein Board dauerhaft.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Listet Ihre Ordner auf.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/folders" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Erstellt einen Ordner zum Organisieren von Links; title ist erforderlich.

cURLLink

curl -X POST "https://api.beklio.com/api/v1/links/folders" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Gibt einen einzelnen Ordner anhand der id zurück.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Aktualisiert einen Ordner teilweise; senden Sie nur die geänderten Felder.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Löscht einen Ordner dauerhaft.

cURLLink

curl -X DELETE "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

QR und Analytics

3 Endpunkte

QR-Status und tägliche Analytics.

Liest QR-Status und Payload.

cURLLink

curl -X GET "https://api.beklio.com/api/v1/links/{id}/qr" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"

Aktualisiert QR-Payload und Erzeugungsstatus.

cURLLink

curl -X PATCH "https://api.beklio.com/api/v1/links/{id}/qr" \
  -H "Authorization: Bearer $BEKLIO_API_KEY" \
  -H "Idempotency-Key: <idempotency-key>" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Summen für Events und Besucher im Bereich ?days=1–365.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/analytics" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Domains

3 Endpunkte

Metadaten verfügbarer und standardmäßiger Domains.

Listet die Domains auf, die Sie lesen können, einschließlich Kurzlink-Domains.
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/domains" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Gibt Ihre Standard-Kurzlink-Domain zurück (null, falls keine vorhanden).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/default" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Listet die Domains auf, auf denen Sie derzeit Links erstellen können (aktiv und innerhalb der Tariflimits).
cURLLink
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/eligible" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```