İçeriğe geç

API referansı

Tüm public uçlar gateway üzerinden /api/v1/links altında çalışır. Bu sayfa herkese açık; gerçek istek göndermek için konsoldaki API tester’ı kullanın.

Uç
45 uç
Grup
5 grup
Scope
5 scope
Metodlar
GET 20
POST 8
PATCH 9
DELETE 8

Routes

17 uç

Hedefleme koşulları, hedefler ve özellikler.

  • Linkin route listesini döner.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Yeni route ekler.

    cURLBağlantı
    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 '{ … }'
  • Bir linkin tek bir route’unu routeId ile döner.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Route günceller.

    cURLBağlantı
    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 '{ … }'
  • Route siler.

    cURLBağlantı
    curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Route koşullarını listeler (COUNTRY, DEVICE_PROFILE, OS, USER_AGENT, LANGUAGE, REFERRER_DOMAIN).

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Koşul ekler (GET ile listelenir; PATCH/DELETE /:conditionId).

    cURLBağlantı
    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 '{ … }'
  • Bir route koşulunu kısmen günceller.

    cURLBağlantı
    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 '{ … }'
  • Bir route koşulunu kalıcı olarak siler.

    cURLBağlantı
    curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Route’un hedef öğelerini (tree veya board öğeleri) listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Katalog hedefi bağlar (GET ile listelenir; PATCH/DELETE /:itemId).

    cURLBağlantı
    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 '{ … }'
  • Bir route hedefini (ör. zorunlu bayrağını) günceller.

    cURLBağlantı
    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 '{ … }'
  • Bir hedefi route’tan kalıcı olarak ayırır.

    cURLBağlantı
    curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Route özelliklerini listeler: PASSWORD, EXPIRATION_DATE, LIMIT, UTM, REDIRECT_DELAY.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Özellik ekler (GET ile listelenir; PATCH/DELETE /:featureId).

    cURLBağlantı
    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 '{ … }'
  • Bir route özelliğinin enabled bayrağını veya config’ini günceller.

    cURLBağlantı
    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 '{ … }'
  • Bir özelliği route’tan kalıcı olarak kaldırır.

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

Trees, boards ve folders

15 uç

Link koleksiyonları. POST oluşturur, PATCH/DELETE /:id günceller ve siler.

  • Tree kaynaklarınızı listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/trees" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Link-in-bio tree oluşturur; username zorunludur (3–64 harf, rakam veya tire).

    cURLBağlantı
    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 '{ … }'
  • Tek bir link-in-bio tree’yi id ile döner.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/trees/{id}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Bir tree’yi kısmen günceller; yalnızca değişen alanları gönderin.

    cURLBağlantı
    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 '{ … }'
  • Bir tree’yi kalıcı olarak siler.

    cURLBağlantı
    curl -X DELETE "https://api.beklio.com/api/v1/links/trees/{id}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Board kaynaklarınızı listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/boards" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Board oluşturur; title ve slug zorunlu, layout isteğe bağlıdır.

    cURLBağlantı
    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 '{ … }'
  • Tek bir board’u id ile döner.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/boards/{id}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Bir board’u kısmen günceller; yalnızca değişen alanları gönderin.

    cURLBağlantı
    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 '{ … }'
  • Bir board’u kalıcı olarak siler.

    cURLBağlantı
    curl -X DELETE "https://api.beklio.com/api/v1/links/boards/{id}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Klasörlerinizi listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/folders" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Linkleri düzenlemek için klasör oluşturur; title zorunludur.

    cURLBağlantı
    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 '{ … }'
  • Tek bir klasörü id ile döner.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/folders/{id}" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Bir klasörü kısmen günceller; yalnızca değişen alanları gönderin.

    cURLBağlantı
    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 '{ … }'
  • Bir klasörü kalıcı olarak siler.

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

QR ve analytics

3 uç

QR durumu ve gün bazlı analytics.

  • QR durumunu ve payload bilgisini okur.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/qr" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • QR payload ve oluşturma durumunu günceller.

    cURLBağlantı
    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 '{ … }'
  • ?days=1–365 aralığında event ve ziyaretçi toplamları.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/{id}/analytics" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"

Domains

3 uç

Kullanılabilir ve varsayılan domain metadata bilgileri.

  • Okuyabildiğiniz alan adlarını, kısa link alan adlarıyla birlikte listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/domains" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Varsayılan kısa link alan adınızı döner (yoksa null).

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/domains/default" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"
  • Şu anda link oluşturabileceğiniz (aktif ve plan sınırları içindeki) alan adlarını listeler.

    cURLBağlantı
    curl -X GET "https://api.beklio.com/api/v1/links/domains/eligible" \
      -H "Authorization: Bearer $BEKLIO_API_KEY"