Создание ссылок и управление ими
Типы ссылок, краткая форма и полный граф маршрутов, обновление и удаление.
Ссылка — это граф маршрутизации, содержащий один или несколько маршрутов (route). Значения kind: DIRECT, TREE, TREE_ITEM, BOARD и BOARD_ITEM; routingMode может быть SIMPLE или ADVANCED.
Краткая форма#
Для ссылок с единственным целевым URL достаточно поля url:
{
"kind": "DIRECT",
"domainId": "bekl.io",
"url": "https://example.com/launch",
"slug": "launch"
}Полный граф маршрутов#
Для ссылок с таргетингом отправляйте массив routes. При использовании полного графа должны быть заданы как минимум один маршрут и один глобальный fallback.
{
"kind": "DIRECT",
"domainId": "bekl.io",
"routes": [{
"platform": "GLOBAL",
"actionType": "URL",
"actionConfig": { "url": "https://example.com/release" },
"isGlobalFallback": true
}]
}Значения actionType: URL, SMS, WHATSAPP, EMAIL, EVENT, EMBED.
Чтение, обновление, удаление#
| Метод | Путь | Scope |
|---|---|---|
| GET | /api/v1/links | links:read |
| GET | /api/v1/links/:id | links:read |
| PATCH | /api/v1/links/:id | links:write |
| DELETE | /api/v1/links/:id | links:delete |
При удалении также удаляются связанные со ссылкой ресурсы графа. О выборе маршрута и таргетинге читайте на странице Маршрутизация.
Чего-то не хватает или есть ошибка? Напишите в поддержку; приложив значение X-Request-Id из ответа, вы ускорите решение.