Api Keys
API keys та швидкий старт з SDK
Створи свій перший API key для Elido, вибери потрібні scope і скороти посилання з командного рядка.
Updated 2026-05-09
API Elido — це REST + JSON, задокументований у форматі OpenAPI 3.1, з обмеженням запитів на ключ. Ми надаємо офіційні SDK для TypeScript, Go та Python, які обгортають його. MCP-сервер у @elido/mcp-server відкриває ту ж поверхню для AI-агентів.
Створи API key#
- Settings → API keys → Create key.
- Вкажи назву (ми рекомендуємо назвати системою, яка буде використовувати ключ:
zapier,internal-billing,marketing-cli). - Вибери scope. Чотири найпоширеніші:
links:read— перегляд і інспекція посилань.links:write— створення, оновлення, видалення посилань.analytics:read— запит подій кліків.webhooks:write— керування webhook-підписками.
- Натисни Create. Ключ відображається один раз — ми зберігаємо лише його хеш.
Якщо ти загубив ключ, відкличи його на тій же сторінці і створи новий. Відкликані ключі відхиляються впродовж 60 секунд у всіх регіонах.
Швидкий старт з TypeScript SDK#
import { ElidoClient } from "@elido/sdk";
const client = new ElidoClient({ apiKey: process.env.ELIDO_API_KEY! });
const link = await client.links.create({
destination: "https://acme.com/spring-sale",
slug: "spring-2026",
});
console.log(link.short_url);
SDK для Go та Python мають таку ж структуру. Повна документація на /api.
Швидкий старт з curl#
curl -X POST https://api.elido.app/v1/links \
-H "Authorization: Bearer $ELIDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"destination":"https://acme.com/spring-sale","slug":"spring-2026"}'
Rate limits#
Безкоштовний рівень отримує 60 запитів на хвилину на ключ. Pro: 600/хв. Business: 6000/хв. Burst — 2× від steady-state ліміту; заголовок відповіді X-RateLimit-Remaining показує поточний стан.
Якщо ти досяг ліміту, API повертає 429 зі встановленим Retry-After. SDK реалізують повтор із exponential backoff за замовчуванням — вимкни це, якщо твій застосунок сам управляє політикою повторів.
Ідемпотентність#
Мутуючі ендпоінти приймають заголовок Idempotency-Key. Передавай UUID для кожного запису, який ти хочеш зробити; ми кешуємо відповідь на 24 години, щоб повтори (мережеві помилки, неоднозначні таймаути) не створювали дублікати.
SDK додають заголовок автоматично. Якщо ти використовуєш curl напряму, генеруй ключ на стороні клієнта і включай його в кожному повторі.
Webhooks#
Для сповіщень у реальному часі замість опитування налаштуй webhooks у Settings → Webhooks — ми доставляємо події link.created, link.clicked.aggregated та domain.verified з HMAC-підписами.