API y SDKs. Build on Elido, in any language.
API REST completa, SDKs para TypeScript, Go y Python, además de un servidor MCP para flujos de trabajo de agentes de IA. Los límites de velocidad escalan según el plan; las claves de API tienen alcance de espacio de trabajo con conjuntos de permisos granulares.
- 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
- API REST con especificación OpenAPI 3.1
- SDKs de TypeScript, Go y Python
- Servidor MCP para Claude, ChatGPT, Cursor
- Claves de API con alcance de espacio de trabajo y permisos por ámbito
- Webhooks para la entrega de eventos asíncronos
- API interna gRPC (edge → core)
Lo que el stack de API de Elido ofrece a los desarrolladores
Una especificación OpenAPI y algunos SDKs son la base. Las capacidades a continuación cubren los detalles que importan al construir integraciones de producción.
Especificación OpenAPI 3.1, colección de Postman y referencia interactiva: cada endpoint documentado con ejemplos
Cada endpoint de la API de Elido está documentado en la especificación OpenAPI 3.1, disponible en /docs/api-reference y como un archivo JSON descargable en /openapi.json. La especificación es la fuente de verdad: los tipos de los SDK se generan a partir de ella, por lo que no hay discrepancias entre la referencia y el SDK. La referencia interactiva de la API te permite realizar llamadas autenticadas contra tu espacio de trabajo directamente desde el navegador (pega tu clave de API, elige el espacio de trabajo, llama al endpoint). Se genera automáticamente una colección de Postman a partir de la especificación OpenAPI y se vincula desde la página de documentación de cada endpoint. El registro de cambios de la API se versiona junto con el registro de cambios principal; los cambios importantes reciben un aviso de depreciación de 90 días con una guía de migración antes de su eliminación.
SDKs de TypeScript, Go y Python: generados a partir de la especificación OpenAPI, actualizados con cada lanzamiento de la API
El SDK de TypeScript (@elido/sdk) se publica en npm y cubre toda la superficie de la API con objetos de solicitud y respuesta tipados. Soporta tanto Node.js como entornos edge (Cloudflare Workers, Vercel Edge, Deno). El SDK de Go (github.com/elidoapp/elido-go) es Go idiomático con propagación de contexto y rutas calientes de asignación cero para un alto rendimiento. El SDK de Python (elido-python, disponible en PyPI) incluye clientes tanto síncronos como asíncronos (asyncio). Los tres SDKs se generan a partir de la misma especificación OpenAPI utilizando un generador personalizado; las actualizaciones se envían el mismo día del lanzamiento de la API. Existen SDKs mantenidos por la comunidad para Ruby y PHP; se listan en los documentos pero no cuentan con soporte oficial. Si tu lenguaje no está cubierto, la especificación OpenAPI es el camino más rápido para construir un cliente.
Claves de API de espacio de trabajo con permisos por ámbito: claves separadas para analíticas de solo lectura, gestión de enlaces o administración
Las claves de API tienen alcance de espacio de trabajo (no de usuario) e incluyen un conjunto de permisos definido al momento de la creación de la clave. Ámbitos: links:read, links:write, links:delete, analytics:read, campaigns:read, campaigns:write, webhooks:manage, domains:manage, workspace:admin. Las integraciones de analíticas de solo lectura deben usar una clave con solo analytics:read. Los pipelines de CI/CD que crean enlaces deben usar links:write. Las operaciones de administración requieren workspace:admin. Las claves se pueden rotar individualmente sin revocar otras claves; la rotación genera un nuevo valor de clave y el valor antiguo se invalida inmediatamente. Las claves se muestran solo una vez al crearlas; Elido almacena un HMAC de la clave, no el texto plano. Para equipos con provisión SCIM, se recomiendan las claves de cuenta de servicio sobre las claves de API personales para integraciones de producción.
Servidor MCP de Elido: conecta la gestión de enlaces a Claude, ChatGPT, Cursor y cualquier agente de IA compatible con MCP
El servidor MCP de Elido (@elido/mcp-server, publicado en npm) implementa el Model Context Protocol y expone la gestión de enlaces de Elido como herramientas invocables por agentes de IA. Herramientas soportadas: create_link, get_link, update_link, list_links, get_analytics, create_campaign, list_campaigns. El servidor MCP se autentica con una clave de API de espacio de trabajo y limita el acceso a las herramientas según los permisos de la clave. Conéctalo al bucle de uso de herramientas de Claude, a los ChatGPT Plugins (llamada a funciones), al contexto de IA de Cursor o a cualquier runtime compatible con MCP. Ejemplo de caso de uso: un asistente de IA que toma un informe en lenguaje natural ('crea cinco enlaces para este lanzamiento de producto, uno por canal, con UTMs de la plantilla de campaña del lanzamiento Q2') y llama a create_link cinco veces con los parámetros correctos derivados del informe. El servidor MCP se puede alojar de forma autónoma o ejecutarse como un binario npx para el desarrollo local.
Límites de velocidad por plan — Free 60/min, Pro 300/min, Business 1,000/min — además de permisos de ráfaga
Los límites de velocidad de la API se aplican por espacio de trabajo por clave de API: Free 60 solicitudes/minuto, Pro 300/minuto, Business 1,000/minuto. Los permisos de ráfaga te permiten exceder el límite hasta por 5 segundos (10 veces el límite de velocidad) antes de que se aplique un límite estricto. Se incluyen encabezados de límite de velocidad en cada respuesta: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (timestamp de Unix). Los SDKs incluyen reintentos automáticos con retroceso exponencial en respuestas 429; no necesitas implementar esto tú mismo. Para operaciones masivas (creación de enlaces, exportación de analíticas), prefiere los endpoints masivos (POST /bulk, exportaciones programadas) sobre las llamadas a la API por elemento; los endpoints masivos tienen límites separados y más altos. Si tu caso de uso requiere un rendimiento sostenido por encima de los límites de Business (por ejemplo, un redireccionador de alto volumen alojado por ti mismo que llama a la API de Elido para poblar el caché), contacta con ventas para un límite personalizado.
Equipos de desarrolladores construyendo sobre la API de Elido
Los nombres son marcadores de posición: los casos de estudio de clientes reales aparecerán aquí a medida que se publiquen.
“Los tipos del SDK de TypeScript se generan a partir de la especificación OpenAPI: cuando Elido lanza una nueva versión de la API, actualizamos la versión del paquete y TypeScript nos indica de inmediato si nuestra integración utiliza un campo depreciado. Sin errores sorpresa en tiempo de ejecución.”
“Conectamos el servidor MCP de Elido a Claude para permitir que nuestro equipo de contenido cree y etiquete enlaces de campaña desde una interfaz de chat. La configuración tomó 20 minutos. El equipo de contenido ahora crea un 40% menos de tickets de soporte a ingeniería para tareas de gestión de enlaces.”
“El SDK de Go con propagación de contexto encaja directamente en nuestra malla de servicios. Creamos enlaces cortos para las páginas de seguimiento de envíos en el lado del servidor, en el momento de la creación del envío; el SDK maneja los reintentos y el retroceso por límite de velocidad de forma transparente.”
API y SDKs de Elido vs API de Bitly vs API de Rebrandly
Los tres tienen APIs REST. Las diferencias radican en la calidad del SDK, los límites de velocidad, la disponibilidad de la especificación OpenAPI y el soporte para MCP/agentes de IA.
| Feature | Elido | Bitly API | Rebrandly API |
|---|---|---|---|
| Especificación OpenAPI / Swagger | OpenAPI 3.1 — descargable, fuente de verdad para SDKs | Especificación Swagger disponible | Especificación OpenAPI disponible |
| SDKs oficiales | TypeScript, Go, Python — generados a partir de la especificación | SDKs oficiales de JavaScript y Python | SDK de JavaScript únicamente |
| Límite de velocidad (Business) | 1,000 solicitudes/min con ráfaga | Plan Enterprise: varía según contrato | 500 solicitudes/min (Business) |
| Servidor MCP para agentes de IA | Sí — @elido/mcp-server en npm | No disponible | No disponible |
| Permisos de clave de API por ámbito | Sí — 9 ámbitos, asignación por clave | Solo lectura vs lectura-escritura únicamente | Control de ámbito limitado |
| Entrega de Webhook | Firmado con HMAC-SHA256, reintento automático, modo SIEM | No disponible | No disponible |
| API interna gRPC | Sí — de edge a core, llamadas internas de baja latencia | Solo REST | Solo REST |
Preguntas sobre API y SDK
¿Tiene versión la API? ¿Cómo funcionan los cambios importantes?
Sí. La versión actual es v1, a la que se accede en /v1/... Los cambios importantes se anuncian en el registro de cambios con un periodo de depreciación de 90 días antes de que se elimine el comportamiento antiguo. Las adiciones que no rompan la compatibilidad (nuevos campos, nuevos parámetros opcionales) se envían sin aumentar la versión. La versión de la API es estable; si alguna vez se introduce la v2, la v1 funcionará en paralelo durante al menos 12 meses. La especificación OpenAPI en /openapi.json siempre refleja la versión estable actual.
¿Qué método de autenticación utiliza la API?
Autenticación por token Bearer: incluye tu clave de API en el encabezado Authorization como 'Bearer elido_sk_...'. El valor de la clave se muestra solo una vez al crearla. Para las llamadas de webhook de servidor a servidor desde Elido a tu sistema, Elido firma el cuerpo de la solicitud con HMAC-SHA256 utilizando un secreto compartido; verifica el encabezado X-Elido-Signature en tu manejador de webhook. Las credenciales de cliente OAuth2 están disponibles para integraciones de socios donde la distribución de claves de API de espacio de trabajo no sea práctica; contáctanos para el registro de socios OAuth2.
¿Funciona el SDK de TypeScript en Cloudflare Workers y entornos edge?
Sí. El SDK de TypeScript utiliza la API fetch (disponible en todos los entornos edge modernos) y evita las APIs exclusivas de Node.js (sin fs, sin http, sin Buffer). Está probado en Cloudflare Workers, Vercel Edge Functions y Deno Deploy. Si estás ejecutando el SDK en un entorno edge restringido, utiliza la ruta de importación ligera (@elido/sdk/edge) que excluye las utilidades de CLI y los módulos exclusivos de Node.js del bundle.
¿Cómo uso el servidor MCP con Claude o ChatGPT?
Para Claude: añade el servidor MCP a tu claude_desktop_config.json con tu clave de API como una variable de entorno; los documentos del MCP de Elido tienen un bloque de configuración para copiar y pegar. Para ChatGPT (llamada a funciones): el servidor MCP expone un manifiesto de herramientas JSON Schema en /.well-known/mcp.json que puedes importar en la configuración de acciones de tu GPT. Para Cursor: añade el servidor MCP como una herramienta local en los ajustes de Cursor con npx @elido/mcp-server. Todas las configuraciones requieren una clave de API de Elido válida con los ámbitos correspondientes.
¿Cuál es el modelo de paginación para los endpoints de lista?
Todos los endpoints de lista utilizan paginación basada en cursor. La respuesta incluye un campo next_cursor (nulo si no hay más páginas). Pasa el valor del cursor como el parámetro de consulta cursor en la siguiente solicitud. El tamaño de página por defecto es 50; el máximo es 200. La paginación basada en cursor es estable: añadir o eliminar registros entre páginas no causa que los elementos se omitan o se repitan, a diferencia de la paginación basada en desplazamiento. Los SDKs incluyen un ayudante de autopaginación que entrega los elementos de uno en uno independientemente de los límites de página.
¿Puedo usar la API para gestionar múltiples espacios de trabajo desde un solo cliente?
Sí. Las claves de API tienen alcance de espacio de trabajo, pero puedes tener claves para múltiples espacios de trabajo. El prefijo del endpoint de la API es /v1/workspaces/{workspace_id}/...; pasa el ID del espacio de trabajo del objetivo. Si estás construyendo una herramienta de gestión de múltiples espacios de trabajo (por ejemplo, un portal de agencia que gestiona espacios de trabajo de clientes), tendrás una clave de API por espacio de trabajo. Las credenciales de socio OAuth2 con alcance para múltiples espacios de trabajo están disponibles para integraciones de plataforma; contacta con ventas.
¿Cuál es el límite de velocidad en el plan gratuito y cómo se aplica?
Plan gratuito: 60 solicitudes por minuto por espacio de trabajo. El límite de velocidad se aplica en el gateway de la API con un algoritmo de cubo de tokens (token bucket). Cuando el cubo está vacío, la API devuelve HTTP 429 con un encabezado Retry-After indicando cuándo estará disponible el próximo token. Los SDKs respetan automáticamente el Retry-After en las respuestas 429. Ten en cuenta que los endpoints masivos tienen límites separados: el endpoint de creación masiva de enlaces cuenta como una solicitud independientemente de cuántos enlaces haya en el cuerpo.
¿Existe un sandbox o entorno de prueba?
Sí: pasa el encabezado X-Elido-Sandbox: true a cualquier solicitud de API para ejecutarla contra el entorno sandbox. Las solicitudes de sandbox crean objetos reales en una partición de espacio de trabajo de sandbox (enlaces, campañas, etc.), pero el tráfico de redirección no se sirve desde el edge de producción. Usa el sandbox para pruebas de integración y pipelines de CI/CD. Los objetos de sandbox no cuentan contra las cuotas de enlaces o clics de tu plan. El sandbox se reinicia cada 24 horas; no dependas de los datos del sandbox para uso en producción.
Keep reading
Entrega de eventos salientes firmados con HMAC: el complemento asíncrono para la API síncrona.
El recurso de API que más llamarás: crea, actualiza y consulta enlaces cortos programáticamente.
Consulta eventos de clic y agregados a través de la API de analíticas: los mismos datos que el panel de ClickHouse.
La página de soluciones orientada a desarrolladores: resumen de REST, SDKs, webhooks y la experiencia del desarrollador.
¿Listo para probarlo?
Empieza con el plan gratuito, actualiza cuando necesites un dominio personalizado.