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

Довідник API

Поточна версія: API v2. Базова адреса:

https://api.revolink.link/apiv2

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

Швидкий старт

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" }'

Або через TypeScript SDK:

ts
import {Revolink} from 'revolink';

const revolink = new Revolink({apiKey: process.env.REVOLINK_API_KEY!, workspaceId: process.env.REVOLINK_WORKSPACE_ID!});
const {shortLink} = await revolink.links.create({url: 'https://example.com'});

Що є в API v2

АвтентифікаціяAPI-ключ, заголовок робочого простору, дозволи, ліміт запитів
ПосиланняСписок, створення, upsert, оновлення, видалення, масові операції
АналітикаАналітика кліків посилання або робочого простору
Теги та домениКерування тегами й власними доменами
Помилки та відповідіФормат відповідей, коди помилок, пагінація
TypeScript SDKnpm install revolink

API v1

Ендпоінти керування за API-ключем в API v1 (/apiv1/link/create та ще п'ять) замінено на API v2, і тепер вони відповідають 410 Gone. Список і те, куди переїхав кожен із них, дивіться в API v1. Публічні ендпоінти v1 і MCP-сервер це не зачіпає.