Return to top
На цій сторінці

Посилання

Усі ендпоінти потребують автентифікації. Базова адреса: https://api.revolink.link/apiv2.

Ендпоінти

МетодURLДозвілОпис
GET/apiv2/linkslinks:readСписок посилань
POST/apiv2/linkslinks:writeСтворення посилання
PUT/apiv2/linkslinks:writeСтворення або оновлення за slug
GET/apiv2/links/{id}links:readОтримання посилання
PATCH/apiv2/links/{id}links:writeОновлення посилання
DELETE/apiv2/links/{id}links:deleteВидалення посилання (безповоротне)
POST/apiv2/links/bulklinks:bulkСтворення до 100 посилань
PATCH/apiv2/links/bulklinks:bulkОновлення до 100 посилань
DELETE/apiv2/links/bulklinks:bulkВидалення до 100 посилань

Аналітика кліків посилання: GET /apiv2/links/{id}/analytics.

GET https://api.revolink.link/apiv2/links

Параметр запитуОпис
page, limitСторінка (за замовчуванням 1) і розмір сторінки (за замовчуванням 50, максимум 200)
searchПідрядок назви, slug або опису
domainКороткий домен. Кілька через кому
activetrue або false
tagIdsID тегів через кому
sortByname, description, shortLink, clicks, active або createdAt (за замовчуванням)
orderasc або desc (за замовчуванням)
rqlФільтр мовою запитів Revolink, дивіться Розширені фільтри
bash
curl "https://api.revolink.link/apiv2/links?search=sale&sortBy=clicks&order=desc" \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id"

POST https://api.revolink.link/apiv2/links

Передайте url для посилання з одним призначенням або rules для смарт-маршрутизації (рівно одне правило за замовчуванням). name за замовчуванням дорівнює хосту призначення, slug генерується, якщо його не вказано, domain за замовчуванням rvlnk.link і може бути підтвердженим доменом робочого простору.

bash
curl -X POST https://api.revolink.link/apiv2/links \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/spring-sale",
    "slug": "spring",
    "expirationDate": "2026-12-31T23:59:59Z"
  }'

Відповідь 201 Created: { "data": { …посилання… } }.

Смарт-маршрутизація

json
{
  "name": "App download",
  "rules": [
    { "isDefault": true, "targetUrl": "https://example.com/download" },
    { "isDefault": false, "targetUrl": "https://apps.apple.com/app/id1", "device": ["mobile"], "os": ["iOS"] }
  ]
}

Правило може збігатися за country, region, city, device, os, browser, locale, timeStart і timeEnd (HH:MM, UTC) та daysOfWeek (0 = неділя). Правило також може мати password.

Інші поля

description, active, tagIds, clicksLimit, expirationDate, expiredUrl, conversionTracking, gpsTracking, shareStats, abTest, ogTitle, ogDescription, appearanceColor, qrColor, qrBgColor, qrShowLogo. Типи й обмеження кожного поля дивіться в інтерактивному довіднику.

PUT https://api.revolink.link/apiv2/links

slug обов'язковий. Якщо посилання з таким slug на цьому domain існує, його оновлюють (slug і домен лишаються), і API відповідає 200. Інакше посилання створюють, і API відповідає 201.

PATCH https://api.revolink.link/apiv2/links/{id}

Передавайте лише те, що змінюється.

  • url замінює призначення правила за замовчуванням.
  • rules, якщо передано, замінюють усі правила. Залиште id кожного правила, яке хочете зберегти: це зберігає його статистику.
  • tagIds це повний список тегів. Порожній масив прибирає всі теги.
bash
curl -X PATCH https://api.revolink.link/apiv2/links/LINK_ID \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

Масові операції

ЗапитТіло
POST /apiv2/links/bulk{ "links": [ …об'єкти посилань, як у створенні… ] }
PATCH /apiv2/links/bulk{ "updates": [ { "id": "…", …поля для зміни… } ] }
DELETE /apiv2/links/bulk{ "ids": [ "…", "…" ] }

Кожен запит приймає від 1 до 100 елементів. Відповідь звітує про кожен елемент окремо, дивіться Помилки та відповіді.