Documentation
Build your integration step by step.
Everything you need to work with the Beklio Link Developer API: 10 guides, about 10 minutes of reading.
Recommended path
If you are new, read in this order; your first request is ready by step two.
- 1QuickstartCreate your first live key and generate your first short link with the API in five minutes. 1 min3 sections
- 2Authentication and scopesbk_live_* keys, the key lifecycle and the scope matrix required per operation. 1 min3 sections
- 3Creating and managing linksLink kinds, the short form versus the full route graph, updating and deleting. 1 min3 sections
Getting started
Your first request, keys, scopes and OAuth.
- QuickstartCreate your first live key and generate your first short link with the API in five minutes. 1 min3 sections 1 min3 sections
- Authentication and scopesbk_live_* keys, the key lifecycle and the scope matrix required per operation. 1 min3 sections 1 min3 sections
- OAuth 2.0 and PKCEThe authorization code + PKCE flow for apps that want to act on behalf of a user. 1 min2 sections 1 min2 sections
Link API
Links, routing, collections, QR and analytics.
- Creating and managing linksLink kinds, the short form versus the full route graph, updating and deleting. 1 min3 sections 1 min3 sections
- Routing and targetingPlatform, condition, target and feature (password, expiry, limit, UTM, delay) sub-resources. 1 min3 sections 1 min3 sections
- Trees, boards and foldersThe lifecycle of link collections: trees, boards and folders. 1 min 1 min
- QR and analyticsReading/updating QR status and daily event/visitor analytics. 1 min2 sections 1 min2 sections
Operations
Pagination, idempotency, errors and versioning.
- Pagination and idempotencyCursor pagination and Idempotency-Key for safe retries. 1 min2 sections 1 min2 sections
- Errors, quotas and limitsThe error envelope, status codes and quota/billing outage behavior. 1 min3 sections 1 min3 sections
- Versioning and deprecationLegacy /api/v1/link/* paths and transition headers. 1 min 1 min