Автентифікація (API v1, видалено)
Ендпоінти API v1 за ключем більше не працюють
Вони відповідають 410 Gone. Використовуйте API v2: ключ передається в Authorization: Bearer <key>, а робочий простір у заголовку X-Workspace-Id. Цю сторінку залишено лише для допомоги з міграцією. Дивіться, куди переїхав кожен ендпоінт.
Усі ендпоінти керування в API v1 потребували автентифікації за API-ключем. Кожен запит має містити дві речі: API-ключ у заголовку запиту та ID робочого простору (Workspace ID) у тілі запиту або в рядку запиту.
Базова URL-адреса
https://api.revolink.link/apiv1/
Як отримати облікові дані
- Відкрийте застосунок Revolink і перейдіть у Профіль → Інтеграції.
- Натисніть Згенерувати API-ключ. Скопіюйте й збережіть ключ: він показується лише один раз. Якщо ви його втратили, згенеруйте новий (старий ключ одразу втрачає чинність).
- Скопіюйте ID робочого простору з тієї самої сторінки.
Передавання API-ключа
Передавайте ключ у заголовку X-Api-Key у кожному запиті:
X-Api-Key: rvlnk_your_api_key_here
Передавання ID робочого простору
Вказуйте workspaceId у кожному запиті:
- POST / PUT / DELETE: у тілі запиту у форматі JSON.
- GET: як параметр запиту.
bash
# POST example
curl -X POST https://api.revolink.link/apiv1/link/create \
-H "Content-Type: application/json" \
-H "X-Api-Key: rvlnk_your_api_key_here" \
-d '{
"workspaceId": "your_workspace_id",
"name": "My link",
"rules": [
{
"id": "rule-1",
"targetUrl": "https://example.com",
"isDefault": true
}
]
}'
Помилки автентифікації
| HTTP-статус | Тіло відповіді | Причина |
|---|---|---|
401 | {"error": "API key is required. Pass it in the X-Api-Key header."} | Відсутній заголовок X-Api-Key |
401 | {"error": "Invalid API key."} | Ключ не збігається з жодним користувачем |
400 | {"error": "workspaceId is required."} | Не передано workspaceId |
400 | {"error": "Invalid workspaceId format."} | workspaceId не є коректним ObjectId |
404 | {"error": "Workspace not found."} | Робочого простору з таким ID не існує |
403 | {"error": "You do not have access to this workspace."} | Власник API-ключа не є учасником чи власником робочого простору |
403 | {"licenseExpired": true, "error": "The workspace license has expired."} | Тариф робочого простору завершився |
Тіла відповідей
Тіла відповідей API завжди англійською, як їх повертає сервер. Тут перекладено лише колонку «Причина».