API e SDK. Build on Elido, in any language.
API REST completa, SDK per TypeScript, Go e Python, oltre a un server MCP per i workflow degli agenti AI. I limiti di velocità scalano con il piano; le chiavi API sono limitate all'area di lavoro con set di permessi granulari.
- 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 specifica OpenAPI 3.1
- SDK per TypeScript, Go e Python
- Server MCP per Claude, ChatGPT, Cursor
- Chiavi API limitate all'area di lavoro con permessi per ambito
- Webhook per la consegna asincrona degli eventi
- API interna gRPC (edge → core)
Cosa offre lo stack API di Elido agli sviluppatori
Una specifica OpenAPI e alcuni SDK sono solo la base. Le funzionalità seguenti coprono i dettagli che contano quando si creano integrazioni per la produzione.
Specifica OpenAPI 3.1, collezione Postman e riferimento interattivo — ogni endpoint documentato con esempi
Ogni endpoint dell'API di Elido è documentato nella specifica OpenAPI 3.1, disponibile su /docs/api-reference e come file JSON scaricabile su /openapi.json. La specifica è l'unica fonte di verità — i tipi SDK sono generati da essa, quindi non c'è discrepanza tra il riferimento e l'SDK. Il riferimento API interattivo ti consente di effettuare chiamate autenticate verso la tua area di lavoro direttamente dal browser (incolla la tua chiave API, scegli l'area di lavoro, chiama l'endpoint). Una collezione Postman viene generata automaticamente dalla specifica OpenAPI e collegata da ogni pagina di documentazione dell'endpoint. Il changelog per l'API è versionato insieme al changelog principale — le modifiche drastiche ricevono un preavviso di deprecazione di 90 giorni con una guida alla migrazione prima della rimozione.
SDK per TypeScript, Go e Python — generati dalla specifica OpenAPI, aggiornati a ogni rilascio dell'API
L'SDK TypeScript (@elido/sdk) è pubblicato su npm e copre l'intera superficie dell'API con oggetti di richiesta e risposta tipizzati. Supporta sia Node.js che i runtime edge (Cloudflare Workers, Vercel Edge, Deno). L'SDK Go (github.com/elidoapp/elido-go) è idiomatico per Go con propagazione del contesto e percorsi caldi a zero allocazioni per un throughput elevato. L'SDK Python (elido-python, disponibile su PyPI) include client sia sincroni che asincroni (asyncio). Tutti e tre gli SDK sono generati dalla stessa specifica OpenAPI utilizzando un generatore personalizzato — gli aggiornamenti vengono rilasciati lo stesso giorno del rilascio dell'API. Esistono SDK mantenuti dalla community per Ruby e PHP; sono elencati nella documentazione ma non supportati ufficialmente. Se il tuo linguaggio non è coperto, la specifica OpenAPI è la via più veloce per creare un client.
Chiavi API dell'area di lavoro con permessi per ambito — chiavi separate per analisi in sola lettura, gestione link o admin
Le chiavi API sono limitate all'area di lavoro (non all'utente) e includono un set di permessi definito al momento della creazione della chiave. Ambiti: links:read, links:write, links:delete, analytics:read, campaigns:read, campaigns:write, webhooks:manage, domains:manage, workspace:admin. Le integrazioni di analisi in sola lettura dovrebbero usare una chiave con solo analytics:read. Le pipeline CI/CD che creano link dovrebbero usare links:write. Le operazioni di admin richiedono workspace:admin. Le chiavi possono essere ruotate individualmente senza revocare altre chiavi — la rotazione genera un nuovo valore di chiave, il vecchio valore viene invalidato immediatamente. Le chiavi vengono mostrate solo una volta al momento della creazione; Elido memorizza un HMAC della chiave, non il testo in chiaro. Per i team con provisioning SCIM, si raccomandano le chiavi degli account di servizio rispetto alle chiavi API personali per le integrazioni di produzione.
Server MCP Elido: connetti la gestione dei link a Claude, ChatGPT, Cursor e a qualsiasi agente AI compatibile con MCP
Il server MCP di Elido (@elido/mcp-server, pubblicato su npm) implementa il Model Context Protocol ed espone la gestione dei link di Elido come strumenti richiamabili dagli agenti AI. Strumenti supportati: create_link, get_link, update_link, list_links, get_analytics, create_campaign, list_campaigns. Il server MCP si autentica con una chiave API dell'area di lavoro e limita l'accesso agli strumenti ai permessi della chiave. Inseriscilo nel loop di utilizzo degli strumenti di Claude, nei ChatGPT Plugins (function calling), nel contesto AI di Cursor o in qualsiasi runtime compatibile con MCP. Esempio di caso d'uso: un assistente AI che riceve un brief in linguaggio naturale ('crea cinque link per questo lancio di prodotto, uno per canale, con UTM dal template della campagna di lancio Q2') e chiama create_link cinque volte con i parametri corretti derivati dal brief. Il server MCP può essere ospitato autonomamente o eseguito come binario npx per lo sviluppo locale.
Limiti di velocità per piano — Free 60/min, Pro 300/min, Business 1.000/min — oltre ai margini di burst
I limiti di velocità delle API si applicano per area di lavoro per chiave API: Free 60 richieste/minuto, Pro 300/minuto, Business 1.000/minuto. I margini di burst ti consentono di superare il limite per un massimo di 5 secondi (10 volte il limite di velocità) prima che intervenga la limitazione rigida. Gli header del limite di velocità sono inclusi in ogni risposta: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (timestamp Unix). Gli SDK includono il retry automatico con backoff esponenziale sulle risposte 429 — non è necessario implementarlo autonomamente. Per le operazioni massive (creazione link, esportazione analisi), preferisci gli endpoint bulk (POST /bulk, esportazioni pianificate) rispetto alle chiamate API per singolo elemento — gli endpoint bulk hanno limiti separati e più elevati. Se il tuo caso d'uso richiede un throughput costante superiore ai limiti Business (ad es., un redirector ad alto volume ospitato autonomamente che chiama l'API di Elido per il popolamento della cache), contatta l'ufficio vendite per un limite personalizzato.
Team di sviluppatori che creano sull'API di Elido
I nomi sono segnaposto — i casi studio reali dei clienti verranno pubblicati qui man mano che saranno disponibili.
“I tipi dell'SDK TypeScript sono generati dalla specifica OpenAPI — quando Elido rilascia una nuova versione dell'API, aggiorniamo la versione del pacchetto e TypeScript ci dice immediatamente se la nostra integrazione usa un campo deprecato. Nessun errore a sorpresa in fase di esecuzione.”
“Abbiamo collegato il server MCP di Elido a Claude per consentire al nostro team di contenuti di creare e taggare i link delle campagne da un'interfaccia di chat. La configurazione ha richiesto 20 minuti. Il team di contenuti ora apre il 40% in meno di ticket di supporto all'ingegneria per le attività di gestione dei link.”
“L'SDK Go con propagazione del contesto si inserisce direttamente nel nostro service mesh. Creiamo link brevi per le pagine di tracciamento delle spedizioni lato server, al momento della creazione della spedizione — l'SDK gestisce i retry e il backoff dei limiti di velocità in modo trasparente.”
API e SDK di Elido vs API di Bitly vs API di Rebrandly
Tutti e tre hanno API REST. Le differenze risiedono nella qualità degli SDK, nei limiti di velocità, nella disponibilità della specifica OpenAPI e nel supporto per MCP/agenti AI.
| Feature | Elido | API di Bitly | API di Rebrandly |
|---|---|---|---|
| Specifica OpenAPI / Swagger | OpenAPI 3.1 — scaricabile, fonte di verità per gli SDK | Specifica Swagger disponibile | Specifica OpenAPI disponibile |
| SDK ufficiali | TypeScript, Go, Python — generati dalla specifica | SDK ufficiali JavaScript e Python | Solo SDK JavaScript |
| Limite di velocità (Business) | 1.000 richieste/min con burst | Piano Enterprise: varia in base al contratto | 500 richieste/min (Business) |
| Server MCP per agenti AI | Sì — @elido/mcp-server su npm | Non disponibile | Non disponibile |
| Permessi chiave API per ambito | Sì — 9 ambiti, assegnazione per chiave | Solo sola lettura o lettura-scrittura | Controllo dell'ambito limitato |
| Consegna webhook | Firmati con HMAC-SHA256, retry automatico, modalità SIEM | Non disponibile | Non disponibile |
| API interna gRPC | Sì — da edge a core, chiamate interne a bassa latenza | Solo REST | Solo REST |
Domande su API e SDK
L'API è versionata? Come funzionano le modifiche drastiche?
Sì. La versione attuale è v1, accessibile su /v1/... Le modifiche drastiche vengono annunciate nel changelog con una finestra di deprecazione di 90 giorni prima della rimozione del vecchio comportamento. Le aggiunte non drastiche (nuovi campi, nuovi parametri opzionali) vengono rilasciate senza incrementare la versione. La versione dell'API è stabile; se mai venisse introdotta la v2, la v1 continuerà a funzionare in parallelo per almeno 12 mesi. La specifica OpenAPI su /openapi.json riflette sempre la versione stabile attuale.
Quale metodo di autenticazione utilizza l'API?
Autenticazione con Bearer token: includi la tua chiave API nell'header Authorization come 'Bearer elido_sk_...'. Il valore della chiave viene mostrato una sola volta al momento della creazione. Per le chiamate webhook da server a server da Elido al tuo sistema, Elido firma il corpo della richiesta con HMAC-SHA256 utilizzando un segreto condiviso — verifica l'header X-Elido-Signature sul tuo gestore di webhook. Le credenziali client OAuth2 sono disponibili per le integrazioni partner in cui la distribuzione delle chiavi API dell'area di lavoro non è pratica — contattaci per l'onboarding partner OAuth2.
L'SDK TypeScript funziona in Cloudflare Workers e nei runtime edge?
Sì. L'SDK TypeScript utilizza l'API fetch (disponibile in tutti i moderni runtime edge) ed evita le API solo per Node.js (niente fs, niente http, niente Buffer). È testato su Cloudflare Workers, Vercel Edge Functions e Deno Deploy. Se esegui l'SDK in un ambiente edge limitato, usa il percorso di importazione leggero (@elido/sdk/edge) che esclude le utilità CLI e i moduli solo per Node.js dal bundle.
Come uso il server MCP con Claude o ChatGPT?
Per Claude: aggiungi il server MCP al tuo file claude_desktop_config.json con la tua chiave API come variabile d'ambiente — la documentazione del server MCP di Elido ha un blocco di configurazione da copiare e incollare. Per ChatGPT (function calling): il server MCP espone un manifesto degli strumenti JSON Schema su /.well-known/mcp.json che puoi importare nella configurazione delle azioni del tuo GPT. Per Cursor: aggiungi il server MCP come strumento locale nelle impostazioni di Cursor con npx @elido/mcp-server. Tutte le configurazioni richiedono una chiave API di Elido valida con gli ambiti pertinenti.
Qual è il modello di paginazione per gli endpoint di elenco?
Tutti gli endpoint di elenco utilizzano la paginazione basata su cursore. La risposta include un campo next_cursor (null se non ci sono più pagine). Passa il valore del cursore come parametro di query cursor nella richiesta successiva. La dimensione predefinita della pagina è 50; il massimo è 200. La paginazione basata su cursore è stabile — l'aggiunta o l'eliminazione di record tra le pagine non causa il salto o la ripetizione degli elementi, a differenza della paginazione basata sull'offset. Gli SDK includono un helper per l'auto-paginazione che restituisce gli elementi uno alla volta, indipendentemente dai confini della pagina.
Posso usare l'API per gestire più aree di lavoro da un singolo client?
Sì. Le chiavi API sono limitate all'area di lavoro, ma puoi possedere chiavi per più aree di lavoro. Il prefisso dell'endpoint API è /v1/workspaces/{workspace_id}/... — passa l'ID dell'area di lavoro di destinazione. Se stai creando uno strumento di gestione multi-area di lavoro (ad es., un portale di agenzia che gestisce le aree di lavoro dei clienti), avrai una chiave API per area di lavoro. Le credenziali partner OAuth2 con ambito multi-area di lavoro sono disponibili per le integrazioni di piattaforma — contatta l'ufficio vendite.
Qual è il limite di velocità sul piano gratuito e come viene applicato?
Piano gratuito: 60 richieste al minuto per area di lavoro. Il limite di velocità viene applicato al gateway API con un algoritmo token bucket. Quando il bucket è vuoto, l'API restituisce HTTP 429 con un header Retry-After che indica quando sarà disponibile il prossimo token. Gli SDK rispettano automaticamente Retry-After sulle risposte 429. Nota che gli endpoint bulk hanno limiti separati — l'endpoint di creazione massiva dei link conta come una singola richiesta, indipendentemente da quanti link ci siano nel payload.
Esiste una sandbox o un ambiente di test?
Sì — passa l'header X-Elido-Sandbox: true a qualsiasi richiesta API per eseguirla nell'ambiente sandbox. Le richieste sandbox creano oggetti reali in una partizione dell'area di lavoro sandbox (link, campagne, ecc.) ma il traffico di reindirizzamento non viene servito dall'edge di produzione. Usa la sandbox per i test di integrazione e le pipeline CI/CD. Gli oggetti sandbox non contano ai fini delle quote di link o clic del tuo piano. La sandbox si resetta ogni 24 ore — non fare affidamento sui dati della sandbox per l'uso in produzione.
Keep reading
Consegna degli eventi in uscita firmata con HMAC — il complemento asincrono all'API sincrona.
La risorsa API che chiamerai di più — crea, aggiorna e interroga i link brevi a livello di programmazione.
Interroga gli eventi clic e gli aggregati tramite l'API di analisi — gli stessi dati della dashboard di ClickHouse.
La pagina delle soluzioni orientata agli sviluppatori — REST, SDK, webhook e panoramica della developer experience.
Pronto a provarlo?
Inizia con il piano gratuito, effettua l'upgrade quando hai bisogno di un dominio personalizzato.