Référence de l’API

Tous les endpoints publics sont servis par la passerelle sous /api/v1/links – cette page est publique ; pour envoyer de vraies requêtes, utilisez le testeur d’API de la console.

Endpoints: 45 endpoints
Groupes: 5 groupes
Scopes: 5 scopes
Méthodes: GET 20; POST 8; PATCH 9; DELETE 8

OpenAPI Testeur d’API Créer une clé

Links

7 endpoints

Cycle de vie des ressources de liens et de graphes de routes.

Liste les liens avec pagination par curseur et filtres.

cURLLien

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

Crée un lien avec la forme courte (url) ou un graphe de routes complet.

cURLLien

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 '{ … }'

Renvoie un lien qui vous appartient, avec son graphe de routes.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Met à jour les métadonnées, le routage et le graphe de routes.

cURLLien

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 '{ … }'

Supprime le lien et les ressources de graphe associées.
cURLLien
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Catalogue des plateformes/appareils en lecture seule.

cURLLien

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

Vérifie si un slug est libre ; accepte en option domainId et excludeLinkId pour un renommage.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/links/slug-availability" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Routes

17 endpoints

Conditions de ciblage, cibles et propriétés.

Renvoie la liste des routes d’un lien.

cURLLien

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

Ajoute une nouvelle route.

cURLLien

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 '{ … }'

Renvoie une seule route d’un lien à partir de son routeId.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Met à jour une route.

cURLLien

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 '{ … }'

Supprime une route.

cURLLien

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

Liste les conditions d’une route (COUNTRY, DEVICE_PROFILE, OS, USER_AGENT, LANGUAGE, REFERRER_DOMAIN).
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Ajoute une condition (liste avec GET ; PATCH/DELETE /:conditionId).

cURLLien

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 '{ … }'

Met à jour partiellement une condition de route.

cURLLien

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 '{ … }'

Supprime définitivement une condition de route.

cURLLien

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

Liste les éléments cibles d’une route (éléments de tree ou de board).
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Associe une cible du catalogue (liste avec GET ; PATCH/DELETE /:itemId).

cURLLien

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 '{ … }'

Met à jour une cible de route (par ex. son indicateur obligatoire).

cURLLien

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 '{ … }'

Détache définitivement une cible de la route.

cURLLien

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

Liste les propriétés d’une route : PASSWORD, EXPIRATION_DATE, LIMIT, UTM, REDIRECT_DELAY.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Ajoute une propriété (liste avec GET ; PATCH/DELETE /:featureId).

cURLLien

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 '{ … }'

Met à jour l’indicateur enabled ou la config d’une propriété de route.

cURLLien

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 '{ … }'

Retire définitivement une propriété de la route.

cURLLien

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

Trees, boards et dossiers

15 endpoints

Collections de liens. POST crée, PATCH/DELETE /:id met à jour et supprime.

Liste vos ressources tree.

cURLLien

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

Crée un tree link-in-bio ; username est obligatoire (3 à 64 lettres, chiffres ou tirets).

cURLLien

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 '{ … }'

Renvoie un seul tree link-in-bio à partir de son id.

cURLLien

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

Met à jour partiellement un tree ; n’envoyez que les champs modifiés.

cURLLien

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 '{ … }'

Supprime définitivement un tree.

cURLLien

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

Liste vos ressources board.

cURLLien

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

Crée un board ; title et slug sont obligatoires, layout est facultatif.

cURLLien

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 '{ … }'

Renvoie un seul board à partir de son id.

cURLLien

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

Met à jour partiellement un board ; n’envoyez que les champs modifiés.

cURLLien

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 '{ … }'

Supprime définitivement un board.

cURLLien

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

Liste vos dossiers.

cURLLien

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

Crée un dossier pour organiser les liens ; title est obligatoire.

cURLLien

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 '{ … }'

Renvoie un seul dossier à partir de son id.

cURLLien

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

Met à jour partiellement un dossier ; n’envoyez que les champs modifiés.

cURLLien

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 '{ … }'

Supprime définitivement un dossier.

cURLLien

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

QR et analytics

3 endpoints

État du QR et analytics quotidiennes.

Lit l’état du QR et son payload.

cURLLien

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

Met à jour le payload du QR et son état de génération.

cURLLien

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 '{ … }'

Totaux d’événements et de visiteurs pour ?days=1–365.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/analytics" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Domaines

3 endpoints

Métadonnées des domaines disponibles et par défaut.

Liste les domaines que vous pouvez lire, y compris les domaines de liens courts.
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/domains" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Renvoie votre domaine de liens courts par défaut (null s’il n’y en a pas).
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/default" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Liste les domaines sur lesquels vous pouvez actuellement créer des liens (actifs et dans les limites de l’offre).
cURLLien
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/eligible" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```