Skip to content
На цій сторінці

Автентифікація

Кожен запит до API v2 потребує двох речей: API-ключа і робочого простору, у якому він працює.

Базова адреса

https://api.revolink.link/apiv2

Специфікація OpenAPI 3.1 доступна за адресою https://api.revolink.link/apiv2/openapi.json, інтерактивна документація: https://api.revolink.link/apiv2/docs.

Де взяти облікові дані

  1. Відкрийте застосунок Revolink і перейдіть у Профіль → API.
  2. Створіть API-ключ і виберіть дозволи, потрібні йому. Скопіюйте ключ: його показують лише один раз.
  3. Скопіюйте ID вашого робочого простору.

Передавання API-ключа

Передавайте ключ як Bearer-токен. Заголовок X-Api-Key теж приймається.

Authorization: Bearer rvlnk_your_api_key_here

Передавання робочого простору

Передавайте ID робочого простору в заголовку X-Workspace-Id у кожному запиті. Власник ключа має бути учасником цього робочого простору.

На відміну від API v1, робочий простір читається лише із цього заголовка, ніколи з тіла запиту чи рядка запиту.

bash
curl https://api.revolink.link/apiv2/me \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id"

GET /me повертає користувача, робочий простір і дозволи ключа, тож це зручний перший запит, щоб перевірити налаштування.

Дозволи

Ключ має дозволи (scopes). Якщо потрібного дозволу немає, ендпоінт відповідає 403 із полем error.requiredPermission.

ДозвілЩо дозволяє
links:readСписок і перегляд посилань
links:writeСтворення, upsert і оновлення посилань
links:deleteВидалення посилання
links:bulkМасове створення, оновлення й видалення (до 100 посилань за запит)
analytics:readАналітика кліків
tags:read / tags:write / tags:deleteПерегляд, створення й оновлення, видалення тегів
domains:read / domains:write / domains:deleteПерегляд, додавання, видалення власних доменів

Ліміт запитів

300 запитів на хвилину на один API-ключ. Після перевищення API відповідає 429 із заголовком Retry-After.

Формат помилок і їхні коди дивіться в розділі Помилки.