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 и интерактивный справочник — каждый эндпоинт документирован с примерами
Каждый эндпоинт API Elido документирован в спецификации 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 с передачей контекста и путями без аллокаций для высокопроизводительного использования. Python SDK (elido-python, доступен на PyPI) включает как синхронный, так и асинхронный (asyncio) клиенты. Все три SDK генерируются из одной и той же спецификации OpenAPI с использованием кастомного генератора — обновления выходят в тот же день, что и релиз API. Существуют поддерживаемые сообществом SDK для Ruby и PHP; они указаны в документации, но официально не поддерживаются. Если вашего языка нет в списке, спецификация OpenAPI — кратчайший путь к созданию клиента.
Ключи API рабочего пространства с разрешениями по областям видимости — отдельные ключи для аналитики (только чтение), управления ссылками или администрирования
Ключи API привязаны к рабочему пространству (а не к пользователю) и включают набор разрешений, определенных при создании ключа. Области видимости: 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 и любому MCP-совместимому AI-агенту
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 (вызов функций), 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 — вам не нужно реализовывать это самостоятельно. Для массовых операций (создание ссылок, экспорт аналитики) отдавайте предпочтение массовым эндпоинтам (POST /bulk, запланированные экспорты) вместо поштучных вызовов API — у массовых эндпоинтов отдельные, более высокие лимиты. Если ваш сценарий требует постоянной пропускной способности выше лимитов Business (например, самохостинг высокопроизводительного редиректора, вызывающего API Elido для наполнения кэша), свяжитесь с отделом продаж для получения индивидуального лимита.
Команды разработчиков, создающие решения на базе API Elido
Имена являются плейсхолдерами — реальные кейсы клиентов появятся здесь по мере публикации.
“Типы TypeScript SDK генерируются из спецификации OpenAPI — когда Elido выпускает новую версию API, мы обновляем версию пакета, и TypeScript сразу сообщает нам, если наша интеграция использует устаревшее поле. Никаких неожиданных ошибок во время выполнения.”
“Мы подключили MCP-сервер Elido к Claude, чтобы наша команда контента могла создавать и помечать ссылки кампаний прямо в интерфейсе чата. Настройка заняла 20 минут. Теперь команда контента создает на 40% меньше тикетов в техподдержку для задач по управлению ссылками.”
“SDK для Go с передачей контекста идеально вписывается в нашу сервисную сетку. Мы создаем короткие ссылки для страниц отслеживания отправлений на стороне сервера в момент создания отправления — SDK прозрачно обрабатывает повторные попытки и ограничения частоты запросов.”
API и SDK Elido в сравнении с API Bitly и API Rebrandly
У всех троих есть 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/... О критических изменениях объявляется в журнале изменений (changelog) с 90-дневным окном устаревания перед удалением старого поведения. Некритические дополнения (новые поля, необязательные параметры) выпускаются без изменения версии. Версия API стабильна; если когда-либо будет представлена v2, v1 будет работать параллельно не менее 12 месяцев. Спецификация OpenAPI на /openapi.json всегда отражает текущую стабильную версию.
Какой метод аутентификации использует API?
Аутентификация с помощью токена Bearer: включите ваш ключ API в заголовок Authorization как 'Bearer elido_sk_...'. Значение ключа отображается один раз при создании. Для вызовов вебхуков типа сервер-сервер от Elido к вашей системе, Elido подписывает тело запроса с помощью HMAC-SHA256, используя общий секрет — проверяйте заголовок X-Elido-Signature в вашем обработчике вебхуков. Клиентские учетные данные OAuth2 доступны для партнерских интеграций, где распределение ключей 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 (вызов функций): 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 включен помощник автопагинации, который выдает элементы по одному, независимо от границ страниц.
Могу ли я использовать API для управления несколькими рабочими пространствами из одного клиента?
Да. Ключи API привязаны к рабочему пространству, но вы можете владеть ключами для нескольких пространств. Префикс эндпоинта API: /v1/workspaces/{workspace_id}/... — передайте ID целевого рабочего пространства. Если вы создаете инструмент управления несколькими рабочими пространствами (например, агентский портал для управления клиентскими пространствами), вам понадобится один ключ API на каждое рабочее пространство. Партнерские учетные данные OAuth2 с доступом к нескольким рабочим пространствам доступны для платформенных интеграций — свяжитесь с отделом продаж.
Каков лимит запросов на бесплатном тарифе и как он контролируется?
Бесплатный тариф: 60 запросов в минуту на рабочее пространство. Лимит запросов контролируется на API-шлюзе с помощью алгоритма token bucket (корзина токенов). Когда корзина пуста, API возвращает HTTP 429 с заголовком Retry-After, указывающим, когда будет доступен следующий токен. SDK автоматически учитывают Retry-After в ответах 429. Обратите внимание, что для массовых эндпоинтов установлены отдельные лимиты — эндпоинт массового создания ссылок считается как один запрос, независимо от количества ссылок в полезной нагрузке.
Есть ли песочница или тестовая среда?
Да — передайте заголовок X-Elido-Sandbox: true в любом запросе API, чтобы выполнить его в среде песочницы. Запросы в песочнице создают реальные объекты в изолированном разделе рабочего пространства (ссылки, кампании и т. д.), но трафик перенаправления не обслуживается из продакшена edge. Используйте песочницу для интеграционного тестирования и конвейеров CI/CD. Объекты песочницы не учитываются в квотах ссылок или кликов вашего тарифного плана. Песочница сбрасывается каждые 24 часа — не полагайтесь на данные песочницы для использования в продакшене.
Keep reading
Доставка исходящих событий с подписью HMAC — асинхронное дополнение к синхронному API.
Ресурс API, который вы будете вызывать чаще всего — программное создание, обновление и запрос коротких ссылок.
Запрос событий кликов и агрегатов через API аналитики — те же данные, что и на дашборде ClickHouse.
Страница решений для разработчиков — обзор REST, SDK, вебхуков и опыта разработки.
Готовы попробовать?
Начните с бесплатного тарифа, перейдите на платный, когда вам понадобится пользовательский домен.