API та SDK. Build on Elido, in any language.
Повний REST API, SDK для TypeScript, Go та Python, а також MCP-сервер для робочих процесів AI-агентів. Ліміти запитів масштабуються залежно від плану; API-ключі діють у межах робочого простору з гранулярними наборами дозволів.
- TypeScript, Go, and Python SDKs — all open-source
- OpenAPI 3.1 spec with interactive docs
- MCP server for Claude and AI agent workflows
- Per-scope API keys with plan-based rate limits
Official SDKs
Four SDKs. One API surface.
Every SDK is generated from the same OpenAPI 3.1 spec — when the API ships, the SDKs update the same day. TypeScript types, Go interfaces, and Python dataclasses stay in sync automatically.
Typed request/response objects. Works in Node.js, Cloudflare Workers, Vercel Edge, and Deno.
npm install @elido/sdkIdiomatic Go with context propagation and zero-allocation hot paths for high-throughput services.
go get github.com/elidoapp/elido-goSync and async (asyncio) clients. Typed with Pydantic v2 models. Available on PyPI.
pip install elido-sdkModel Context Protocol server — connect Elido link management to Claude, ChatGPT, Cursor, and any MCP-compatible AI agent.
npx @elido/mcp-serverAPI reference
OpenAPI 3.1. Interactive. Always current.
The OpenAPI spec at /openapi.json is the source of truth for every endpoint, parameter, and response shape. SDK types are generated from it — no drift, no hand-maintained stubs.
- Downloadable spec/openapi.json — machine-readable JSON
- Interactive referenceAuthenticated calls from the browser
- Postman collectionAuto-generated from the OpenAPI spec
- SDK generationTypes built from spec on every release
- 90-day deprecationBreaking changes flagged well in advance
- POST
/v1/linksCreate a short link - GET
/v1/links/{id}Retrieve a link by ID - PATCH
/v1/links/{id}Update link destination or metadata - DELETE
/v1/links/{id}Archive or delete a link - GET
/v1/linksList links (cursor-paginated) - POST
/v1/bulk/linksBulk-create up to 500 links
X-RateLimit-Remaining
X-RateLimit-Reset
Rate limits
Limits that scale with your plan.
Token-bucket rate limiting per workspace per API key. Burst allowances let you spike 10x for up to 5 seconds — so a batch link-creation job at the start of a campaign never hits the wall.
- X-RateLimit-Limit / Remaining / Reset headers on every response
- SDK auto-retries with exponential backoff on 429
- Bulk endpoints have separate, higher limits
- Per-scope keys — analytics read-only keys don't burn write quota
- Custom limits for high-volume enterprise workloads — contact sales
What you can do
- REST API зі специфікацією OpenAPI 3.1
- SDK для TypeScript, Go та Python
- MCP-сервер для Claude, ChatGPT, Cursor
- API-ключі в межах робочого простору з дозволами на рівні областей доступу
- Вебхуки для асинхронної доставки подій
- Внутрішній gRPC API (edge → core)
Що стек API Elido дає розробникам
Специфікація OpenAPI та кілька SDK — це лише база. Можливості нижче охоплюють деталі, які мають значення при створенні інтеграцій для продакшну.
Специфікація OpenAPI 3.1, колекція Postman та інтерактивний довідник — кожен ендпоінт задокументований із прикладами
Кожен ендпоінт Elido API задокументований у специфікації OpenAPI 3.1, доступній за адресою /docs/api-reference та як завантажуваний JSON-файл на /openapi.json. Специфікація є єдиним джерелом істини — типи SDK генеруються на її основі, тому немає розбіжностей між довідником та SDK. Інтерактивний довідник API дозволяє робити автентифіковані виклики до вашого робочого простору безпосередньо з браузера (вставте свій API-ключ, виберіть робочий простір, викличте ендпоінт). Колекція Postman автоматично генерується зі специфікації OpenAPI та посилається на кожній сторінці документації ендпоінта. Журнал змін (Changelog) для API версіонується разом з основним журналом змін — про критичні зміни повідомляється за 90 днів до видалення з наданням посібника з міграції.
SDK для TypeScript, Go та Python — згенеровані зі специфікації OpenAPI, оновлюються з кожним релізом API
TypeScript SDK (@elido/sdk) публікується в npm і охоплює всю поверхню API з типізованими об'єктами запитів і відповідей. Він підтримує як Node.js, так і edge-середовища (Cloudflare Workers, Vercel Edge, Deno). Go SDK (github.com/elidoapp/elido-go) — це ідіоматичний Go з пробросом контексту та шляхами з нульовим виділенням пам'яті (zero-allocation) для високої пропускної здатності. Python SDK (elido-python, доступний на PyPI) включає як синхронні, так і асинхронні (asyncio) клієнти. Усі три SDK генеруються з однієї специфікації OpenAPI за допомогою кастомного генератора — оновлення виходять у той самий день, що й реліз API. Існують SDK для Ruby та PHP, що підтримуються спільнотою; вони перелічені в документації, але не підтримуються офіційно. Якщо вашої мови немає в списку, специфікація OpenAPI — найшвидший шлях до створення клієнта.
API-ключі робочого простору з дозволами на рівні областей доступу — окремі ключі для аналітики, керування посиланнями та адміністрування
API-ключі діють у межах робочого простору (не користувача) і включають набір дозволів, визначений під час створення ключа. Області доступу (scopes): links:read, links:write, links:delete, analytics:read, campaigns:read, campaigns:write, webhooks:manage, domains:manage, workspace:admin. Для інтеграцій аналітики тільки для читання слід використовувати ключ лише з analytics:read. CI/CD конвеєри, що створюють посилання, повинні використовувати links:write. Адміністративні операції вимагають workspace:admin. Ключі можна ротувати індивідуально без відкликання інших ключів — ротація генерує нове значення ключа, старе значення анулюється негайно. Ключі показуються лише один раз при створенні; Elido зберігає HMAC ключа, а не відкритий текст. Для команд, що використовують SCIM, рекомендуються ключі сервісних акаунтів замість особистих API-ключів для продакшн-інтеграцій.
MCP-сервер Elido: підключіть керування посиланнями до Claude, ChatGPT, Cursor та будь-якого AI-агента з підтримкою MCP
MCP-сервер Elido (@elido/mcp-server, опублікований в npm) реалізує Model Context Protocol і надає керування посиланнями Elido як інструменти, що можуть викликатися AI-агентами. Підтримувані інструменти: create_link, get_link, update_link, list_links, get_analytics, create_campaign, list_campaigns. MCP-сервер автентифікується за допомогою API-ключа робочого простору та обмежує доступ до інструментів відповідно до дозволів ключа. Підключіть його до циклу використання інструментів Claude, ChatGPT Plugins (function calling), контексту AI в Cursor або будь-якого середовища виконання, сумісного з MCP. Приклад використання: AI-асистент отримує завдання природною мовою («створи п'ять посилань для цього запуску продукту, по одному на канал, з UTM-мітками з шаблону кампанії Q2-launch») і викликає create_link п'ять разів з правильними параметрами, отриманими із завдання. MCP-сервер можна хостити самостійно або запускати як бінарний файл через npx для локальної розробки.
Ліміти запитів за планом — Free 60/хв, Pro 300/хв, Business 1,000/хв — плюс допуски на сплески
Ліміти запитів API застосовуються на робочий простір на API-ключ: Free 60 запитів/хвилину, Pro 300/хвилину, Business 1,000/хвилину. Допуски на сплески дозволяють перевищувати ліміт до 5 секунд (у 10 разів більше ліміту), перш ніж спрацює жорстке обмеження. Заголовки лімітів запитів додаються до кожної відповіді: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix timestamp). SDK включають автоматичне повторення запиту з експоненціальною затримкою при відповідях 429 — вам не потрібно реалізовувати це самостійно. Для масових операцій (створення посилання, експорт аналітики) віддавайте перевагу bulk-ендпоінтам (POST /bulk, запланований експорт) замість поштучних викликів API — bulk-ендпоінти мають окремі, вищі ліміти. Якщо ваш сценарій використання вимагає постійної пропускної здатності вище лімітів Business (наприклад, самостійно розміщений високонавантажений редиректор, що викликає API Elido для наповнення кешу), зверніться до відділу продажів за індивідуальним лімітом.
Команди розробників, що будують на API Elido
Імена є плейсхолдерами — реальні кейси клієнтів з'являться тут після публікації.
“Типи TypeScript SDK генеруються зі специфікації OpenAPI — коли Elido випускає нову версію API, ми оновлюємо версію пакета, і TypeScript негайно повідомляє нам, якщо наша інтеграція використовує застаріле поле. Жодних несподіваних помилок під час виконання.”
“Ми підключили MCP-сервер Elido до Claude, щоб дозволити нашій команді контенту створювати та тегувати посилання на кампанії через чат-інтерфейс. Налаштування зайняло 20 хвилин. Тепер команда контенту створює на 40% менше тікетів до інженерного відділу щодо завдань керування посиланнями.”
“Go SDK з пробросом контексту ідеально вписується безпосередньо в нашу сервісну сітку. Ми створюємо короткі посилання для сторінок відстеження відправлень на стороні сервера в момент створення відправлення — SDK прозоро обробляє повтори та затримки лімітів запитів.”
Elido API та SDK проти Bitly API та Rebrandly API
Усі три мають REST API. Відмінності полягають у якості SDK, лімітах запитів, наявності специфікації OpenAPI та підтримці MCP/AI-агентів.
| Feature | Elido | Bitly API | Rebrandly API |
|---|---|---|---|
| OpenAPI / специфікація Swagger | OpenAPI 3.1 — можна завантажити, джерело істини для SDK | Доступна специфікація Swagger | Доступна специфікація OpenAPI |
| Офіційні SDK | TypeScript, Go, Python — згенеровані зі специфікації | Офіційні SDK для JavaScript та Python | Тільки JavaScript SDK |
| Ліміт запитів (Business) | 1,000 запитів/хв зі сплесками | План Enterprise: залежить від контракту | 500 запитів/хв (Business) |
| MCP-сервер для AI-агентів | Так — @elido/mcp-server в npm | Недоступно | Недоступно |
| Дозволи API-ключів на рівні областей доступу | Так — 9 областей, призначення на ключ | Тільки читання або читання-запис | Обмежений контроль областей доступу |
| Доставка вебхуків | Підписані HMAC-SHA256, автоповтор, режим SIEM | Недоступно | Недоступно |
| Внутрішній gRPC API | Так — edge до core, внутрішні виклики з низькою затримкою | Тільки REST | Тільки REST |
Питання про API та SDK
Чи версіонується API? Як працюють критичні зміни?
Так. Поточна версія — v1, доступ до якої здійснюється через /v1/... Про критичні зміни повідомляється в журналі змін з 90-денним вікном депрекації до видалення старої поведінки. Некратні доповнення (нові поля, нові необов'язкові параметри) виходять без зміни версії. Версія API стабільна; якщо колись буде введена v2, v1 працюватиме паралельно щонайменше 12 місяців. Специфікація OpenAPI на /openapi.json завжди відображає поточну стабільну версію.
Який метод автентифікації використовує API?
Автентифікація через Bearer token: додайте ваш API-ключ у заголовок Authorization як 'Bearer elido_sk_...'. Значення ключа показується один раз при створенні. Для викликів вебхуків типу сервер-сервер від Elido до вашої системи, Elido підписує тіло запиту за допомогою HMAC-SHA256 з використанням спільного секрету — перевіряйте заголовок X-Elido-Signature у вашому обробнику вебхуків. OAuth2 client credentials доступні для партнерських інтеграцій, де розповсюдження API-ключів робочого простору є недоцільним — зв'яжіться з нами для партнерського підключення через OAuth2.
Чи працює TypeScript SDK у Cloudflare Workers та edge-середовищах?
Так. TypeScript SDK використовує fetch API (доступний у всіх сучасних edge-середовищах) і уникає API, специфічних для Node.js (без fs, без http, без Buffer). Він протестований на Cloudflare Workers, Vercel Edge Functions та Deno Deploy. Якщо ви запускаєте SDK в обмеженому edge-середовищі, використовуйте полегшений шлях імпорту (@elido/sdk/edge), який виключає утиліти CLI та модулі тільки для Node.js із бандла.
Як використовувати MCP-сервер із Claude або ChatGPT?
Для Claude: додайте MCP-сервер у свій claude_desktop_config.json з вашим API-ключем як змінною оточення — у документації Elido MCP є блок конфігурації для копіювання. Для ChatGPT (function calling): MCP-сервер надає маніфест інструментів JSON Schema за адресою /.well-known/mcp.json, який ви можете імпортувати в конфігурацію дій вашого GPT. Для Cursor: додайте MCP-сервер як локальний інструмент у налаштуваннях Cursor за допомогою npx @elido/mcp-server. Усі конфігурації потребують валідного API-ключа Elido з відповідними областями доступу.
Яка модель пагінації для списків?
Усі ендпоінти списків використовують пагінацію на основі курсорів. Відповідь містить поле next_cursor (null, якщо сторінок більше немає). Передайте значення курсора як параметр запиту cursor у наступному запиті. Стандартний розмір сторінки — 50; максимальний — 200. Пагінація на основі курсорів стабільна — додавання або видалення записів між сторінками не призводить до пропуску або дублювання елементів, на відміну від пагінації на основі зміщення (offset). SDK включають помічник auto-paginate, який видає елементи по одному незалежно від меж сторінок.
Чи можу я використовувати API для керування кількома робочими просторами з одного клієнта?
Так. API-ключі діють у межах робочого простору, але ви можете мати ключі для кількох робочих просторів. Префікс ендпоінта API — /v1/workspaces/{workspace_id}/... — передайте ID цільового робочого простору. Якщо ви створюєте інструмент керування кількома робочими просторами (наприклад, агентський портал для керування просторами клієнтів), ви матимете по одному API-ключу на кожен робочий простір. Облікові дані партнерів OAuth2 з крос-просторовою областю доступу доступні для платформних інтеграцій — зверніться до відділу продажів.
Який ліміт запитів на безкоштовному плані та як він контролюється?
Безкоштовний план: 60 запитів на хвилину на робочий простір. Ліміт запитів контролюється на шлюзі API за допомогою алгоритму маркерного кошика (token bucket). Коли кошик порожній, API повертає HTTP 429 із заголовком Retry-After, що вказує, коли буде доступний наступний маркер. SDK автоматично враховують Retry-After при відповідях 429. Зверніть увагу, що bulk-ендпоінти мають окремі ліміти — ендпоінт масового створення посилань рахується як один запит незалежно від кількості посилань у корисному навантаженні.
Чи є пісочниця або тестове середовище?
Так — передайте заголовок X-Elido-Sandbox: true до будь-якого запиту API, щоб запустити його в середовищі пісочниці. Запити в пісочниці створюють реальні об'єкти в ізольованому розділі робочого простору (посилання, кампанії тощо), але трафік редиректів не обслуговується з продакшн edge. Використовуйте пісочницю для інтеграційного тестування та CI/CD конвеєрів. Об'єкти пісочниці не враховуються у квотах посилань або кліків вашого плану. Пісочниця скидається кожні 24 години — не покладайтеся на дані пісочниці для продакшн використання.
Keep reading
Підписана HMAC доставка вихідних подій — асинхронне доповнення до синхронного API.
Ресурс API, який ви будете викликати найчастіше — створюйте, оновлюйте та запитуйте короткі посилання програмно.
Запитуйте події кліків та агрегати через аналітичний API — ті самі дані, що й на дашборді ClickHouse.
Сторінка рішень для розробників — огляд REST, SDK, вебхуків та досвіду розробки.
Готові спробувати?
Почніть з безкоштовного плану, оновіть, коли вам знадобиться власний домен.