Справочник API

Все публичные эндпоинты работают через шлюз по адресу /api/v1/links – эта страница открыта для всех; чтобы отправлять реальные запросы, используйте тестер API в консоли.

Эндпоинты: Эндпоинтов: 45
Группы: Групп: 5
Scope: Scope: 5
Методы: GET 20; POST 8; PATCH 9; DELETE 8

OpenAPI Тестер API Создать ключ

Ссылки (Links)

Эндпоинтов: 7

Жизненный цикл ресурсов ссылок и графа маршрутов.

Возвращает список ссылок с курсорной пагинацией и фильтрами.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Создаёт ссылку в краткой форме (url) или с полным графом маршрутов.

cURLСсылка

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

Возвращает принадлежащую вам ссылку вместе с графом маршрутов.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Обновляет метаданные, маршрутизацию и граф маршрутов.

cURLСсылка

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

Удаляет ссылку и связанные ресурсы графа.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Каталог платформ и устройств только для чтения.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/platform-catalog" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Проверяет, свободен ли slug; принимает необязательные domainId и excludeLinkId для переименования.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/links/slug-availability" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Маршруты (Routes)

Эндпоинтов: 17

Условия таргетинга, цели и свойства.

Возвращает список маршрутов ссылки.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Добавляет новый маршрут.

cURLСсылка

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

Возвращает один маршрут ссылки по routeId.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Обновляет маршрут.

cURLСсылка

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

Удаляет маршрут.

cURLСсылка

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

Возвращает условия маршрута (COUNTRY, DEVICE_PROFILE, OS, USER_AGENT, LANGUAGE, REFERRER_DOMAIN).
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Добавляет условие (список через GET; PATCH/DELETE /:conditionId).

cURLСсылка

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

Частично обновляет условие маршрута.

cURLСсылка

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

Безвозвратно удаляет условие маршрута.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/conditions/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает целевые элементы маршрута (элементы tree или board).
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Привязывает цель из каталога (список через GET; PATCH/DELETE /:itemId).

cURLСсылка

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

Обновляет цель маршрута (например, флаг обязательности).

cURLСсылка

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

Безвозвратно отвязывает цель от маршрута.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/targets/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает свойства маршрута: PASSWORD, EXPIRATION_DATE, LIMIT, UTM, REDIRECT_DELAY.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Добавляет свойство (список через GET; PATCH/DELETE /:featureId).

cURLСсылка

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

Обновляет флаг enabled или config свойства маршрута.

cURLСсылка

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

Безвозвратно удаляет свойство из маршрута.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/{id}/routes/{routeId}/features/{childId}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Tree, board и папки

Эндпоинтов: 15

Коллекции ссылок. POST создаёт, PATCH/DELETE /:id обновляет и удаляет.

Возвращает список ваших ресурсов tree.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/trees" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Создаёт link-in-bio tree; username обязателен (3–64 буквы, цифры или дефисы).

cURLСсылка

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

Возвращает один link-in-bio tree по id.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Частично обновляет tree; отправляйте только изменённые поля.

cURLСсылка

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

Безвозвратно удаляет tree.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/trees/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает список ваших ресурсов board.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/boards" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Создаёт board; title и slug обязательны, layout необязателен.

cURLСсылка

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

Возвращает один board по id.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Частично обновляет board; отправляйте только изменённые поля.

cURLСсылка

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

Безвозвратно удаляет board.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/boards/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает список ваших папок.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/folders" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Создаёт папку для организации ссылок; title обязателен.

cURLСсылка

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

Возвращает одну папку по id.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Частично обновляет папку; отправляйте только изменённые поля.

cURLСсылка

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

Безвозвратно удаляет папку.
cURLСсылка
```
curl -X DELETE "https://api.beklio.com/api/v1/links/folders/{id}" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

QR и аналитика

Эндпоинтов: 3

Состояние QR и посуточная аналитика.

Читает состояние QR и payload.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/qr" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Обновляет payload QR и состояние генерации.

cURLСсылка

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.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/{id}/analytics" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```

Домены

Эндпоинтов: 3

Метаданные доступных доменов и домена по умолчанию.

Возвращает домены, доступные вам для чтения, включая домены коротких ссылок.
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/domains" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает ваш домен коротких ссылок по умолчанию (null, если его нет).
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/default" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```
Возвращает домены, на которых вы сейчас можете создавать ссылки (активные и в пределах лимитов тарифа).
cURLСсылка
```
curl -X GET "https://api.beklio.com/api/v1/links/domains/eligible" \
  -H "Authorization: Bearer $BEKLIO_API_KEY"
```