API & SDK's. Bouw op Elido, in elke taal.
Volledige REST API, TypeScript-, Go- en Python-SDK's, plus een MCP-server voor AI-agentworkflows. Rate limits schalen mee met je plan; API-keys zijn workspace-scoped met granulaire permissiesets.
- TypeScript-, Go- en Python-SDK's - allemaal open source
- OpenAPI 3.1-spec met interactieve documentatie
- MCP-server voor Claude en AI-agentworkflows
- API-keys per scope met plangebaseerde rate limits
Officiële SDK's
Vier SDK's. Één API-oppervlak.
Elke SDK wordt gegenereerd uit dezelfde OpenAPI 3.1-spec - zodra de API verschijnt, worden de SDK's dezelfde dag geüpdatet. TypeScript-types, Go-interfaces en Python-dataclasses blijven automatisch in sync.
Getypeerde request-/response-objecten. Werkt in Node.js, Cloudflare Workers, Vercel Edge en Deno.
npm install @elido/sdkIdiomatisch Go met context-propagatie en zero-allocation hot paths voor high-throughput services.
go get github.com/elidoapp/elido-goSync- en async (asyncio)-clients. Getypeerd met Pydantic v2-modellen. Beschikbaar op PyPI.
pip install elido-sdkModel Context Protocol-server - koppel Elido-linkbeheer aan Claude, ChatGPT, Cursor en elke MCP-compatibele AI-agent.
npx @elido/mcp-serverAPI-referentie
OpenAPI 3.1. Interactief. Altijd actueel.
De OpenAPI-spec op /openapi.json is de single source of truth voor elk endpoint, elke parameter en elke responsvorm. SDK-types worden hieruit gegenereerd - geen afwijking, geen handmatig onderhouden stubs.
- Downloadbare spec/openapi.json - machineleesbare JSON
- Interactieve referentieGeauthenticeerde calls vanuit de browser
- Postman-collectieAutomatisch gegenereerd uit de OpenAPI-spec
- SDK-generatieTypes gebouwd uit de spec bij elke release
- 90-dagen deprecationBreaking changes ruim op tijd gemarkeerd
- POST
/v1/linksMaak een short link - GET
/v1/links/{id}Haal een link op via ID - PATCH
/v1/links/{id}Werk bestemming of metadata van de link bij - DELETE
/v1/links/{id}Archiveer of verwijder een link - GET
/v1/linksToon links (cursor-gepagineerd) - POST
/v1/bulk/linksMaak tot 500 links in bulk aan
X-RateLimit-Remaining
X-RateLimit-Reset
Rate limits
Limieten die meeschalen met je plan.
Token bucket-ratelimiting per workspace per API-key. Burst-toeslagen laten je tot 10x pieken voor maximaal 5 seconden - zodat een batch-linkaanmaakjob aan het begin van een campagne nooit de muur raakt.
- X-RateLimit-Limit / Remaining / Reset-headers op elk antwoord
- SDK doet automatische retries met exponentiële backoff bij 429
- Bulk-endpoints hebben afzonderlijke, hogere limieten
- Keys per scope - read-only analyticskeys verbruiken geen write-quota
- Aangepaste limieten voor high-volume enterprise-workloads - neem contact op met sales
Wat je kunt doen
- REST API met OpenAPI 3.1-spec
- TypeScript-, Go- en Python-SDK's
- MCP-server voor Claude, ChatGPT, Cursor
- Workspace-scoped API-keys met permissies per scope
- Webhooks voor asynchrone eventaflevering
- Interne gRPC-API (edge → core)
Wat de Elido API-stack developers biedt
Een OpenAPI-spec en een paar SDK's zijn het minimum. De onderstaande mogelijkheden behandelen de details die belangrijk zijn bij het bouwen van productie-integraties.
OpenAPI 3.1-spec, Postman-collectie en interactieve referentie - elk endpoint gedocumenteerd met voorbeelden
Elk Elido API-endpoint is gedocumenteerd in de OpenAPI 3.1-spec, beschikbaar op /docs/api-reference en als downloadbaar JSON-bestand op /openapi.json. De spec is de single source of truth - SDK-types worden hieruit gegenereerd, zodat er geen afwijking is tussen de referentie en de SDK. Met de interactieve API-referentie kun je vanuit de browser geauthenticeerde calls doen tegen je workspace (plak je API-key, kies de workspace, roep het endpoint aan). Een Postman-collectie wordt automatisch gegenereerd uit de OpenAPI-spec en gelinkt vanaf de documentatiepagina van elk endpoint. De changelog voor de API is versioned naast de hoofdchangelog - breaking changes krijgen een deprecation-melding van 90 dagen met een migratiegids vóórdat ze worden verwijderd.
TypeScript-, Go- en Python-SDK's - gegenereerd uit de OpenAPI-spec, bijgewerkt bij elke API-release
De TypeScript-SDK (@elido/sdk) wordt gepubliceerd op npm en dekt het volledige API-oppervlak met getypeerde request- en response-objecten. Hij ondersteunt zowel Node.js als edge-runtimes (Cloudflare Workers, Vercel Edge, Deno). De Go-SDK (github.com/elidoapp/elido-go) is idiomatisch Go met context-propagatie en zero-allocation hot paths voor high-throughput gebruik. De Python-SDK (elido-python, beschikbaar op PyPI) bevat zowel sync- als async (asyncio)-clients. De Ruby-SDK (elido-gem op RubyGems) levert idiomatische Ruby met sync HTTP en ActiveRecord-vriendelijke errortypes. Alle vier SDK's worden gegenereerd uit dezelfde OpenAPI-spec met een aangepaste generator - updates verschijnen op dezelfde dag als de API-release. Is jouw taal niet gedekt, dan is de OpenAPI-spec het snelste pad om een client te bouwen.
Workspace API-keys met permissies per scope - afzonderlijke keys voor read-only analytics vs linkbeheer vs admin
API-keys zijn workspace-scoped (niet gebruiker-scoped) en bevatten een permissieset die wordt bepaald bij het aanmaken van de key. Scopes: links:read, links:write, links:delete, analytics:read, campaigns:read, campaigns:write, webhooks:manage, domains:manage, workspace:admin. Read-only analytics-integraties zouden een key met alleen analytics:read moeten gebruiken. CI/CD-pipelines die links aanmaken, zouden links:write moeten gebruiken. Adminbewerkingen vereisen workspace:admin. Keys kunnen afzonderlijk worden geroteerd zonder andere keys in te trekken - rotatie genereert een nieuwe keywaarde, de oude waarde wordt direct ongeldig gemaakt. Keys worden slechts eenmaal getoond bij het aanmaken; Elido slaat een HMAC van de key op, niet de plaintext. Voor SCIM-geprovisioneerde teams worden service-account-keys aanbevolen boven persoonlijke API-keys voor productie-integraties.
Elido MCP-server: koppel linkbeheer aan Claude, ChatGPT, Cursor en elke MCP-compatibele AI-agent
De Elido MCP-server (@elido/mcp-server, gepubliceerd op npm) implementeert het Model Context Protocol en stelt Elido-linkbeheer bloot als tools die door AI-agents kunnen worden aangeroepen. Ondersteunde tools: create_link, get_link, update_link, list_links, get_analytics, create_campaign, list_campaigns. De MCP-server authenticeert met een workspace API-key en beperkt tooltoegang tot de permissies van de key. Koppel hem aan de tool-use-loop van Claude, de ChatGPT Plugins (function calling), de AI-context van Cursor, of elke MCP-compatibele runtime. Use case-voorbeeld: een AI-assistent die een natuurlijke-taalbriefing ontvangt ('maak vijf links voor deze productlancering, één per kanaal, met UTM's uit de Q2-launch-campagnetemplate') en vijf keer create_link aanroept met de juiste parameters afgeleid uit de briefing. De MCP-server is self-hostable of draait als npx-binary voor lokale ontwikkeling.
Rate limits per plan - Free 60/min, Pro 300/min, Business 1.000/min - plus burst-toeslagen
API-rate limits gelden per workspace per API-key: Free 60 verzoeken/minuut, Pro 300/minuut, Business 1.000/minuut. Burst-toeslagen laten je de limiet tot 5 seconden overschrijden (10x de rate limit) voordat harde limitering intreedt. Rate limit-headers zitten in elk antwoord: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix-timestamp). De SDK's bevatten automatische retry met exponentiële backoff bij 429-responses - je hoeft dit niet zelf te implementeren. Voor bulkbewerkingen (linkaanmaak, analytics-export) heb je de voorkeur voor de bulk-endpoints (POST /bulk, geplande exports) boven per-item API-calls - bulk-endpoints hebben afzonderlijke, hogere limieten. Vereist jouw use case aanhoudende doorvoer boven Business-limieten (bijvoorbeeld een self-hosted high-volume redirector die Elido's API aanroept voor cachevulling), neem dan contact op met sales voor een aangepaste limiet.
Developerteams die op de Elido API bouwen
Namen zijn placeholders - echte klantcasestudy's komen hier zodra ze gepubliceerd zijn.
“De TypeScript-SDK-types worden gegenereerd uit de OpenAPI-spec - wanneer Elido een nieuwe API-versie uitbrengt, updaten we de packageversie en zegt TypeScript ons direct of onze integratie een verouderd veld gebruikt. Geen onverwachte runtime-errors.”
“We hebben de Elido MCP-server aan Claude gekoppeld, zodat ons contentteam campagnelinks kan aanmaken en taggen via een chatinterface. De setup duurde 20 minuten. Het contentteam maakt nu 40% minder supporttickets naar engineering voor linkbeheertaken.”
“De Go-SDK met context-propagatie past direct in onze service mesh. We maken server-side short links aan voor zendingtrackingpagina's, op het moment van zendingsaanmaak - de SDK regelt retries en rate limit-backoff transparant.”
Elido API & SDK's vs Bitly API vs Rebrandly API
Alle drie hebben REST API's. De verschillen liggen in SDK-kwaliteit, rate limits, beschikbaarheid van OpenAPI-spec en MCP/AI-agentondersteuning.
| Feature | Elido | Bitly API | Rebrandly API |
|---|---|---|---|
| OpenAPI-/Swagger-spec | OpenAPI 3.1 - downloadbaar, single source of truth voor SDK's | Swagger-spec beschikbaar | OpenAPI-spec beschikbaar |
| Officiële SDK's | TypeScript, Go, Python - gegenereerd uit de spec | Officiële JavaScript- en Python-SDK's | Alleen JavaScript-SDK |
| Rate limit (Business) | 1.000 verzoeken/min met burst | Enterprise-plan: varieert per contract | 500 verzoeken/min (Business) |
| MCP-server voor AI-agents | Ja - @elido/mcp-server op npm | Niet beschikbaar | Niet beschikbaar |
| API-keypermissies per scope | Ja - 9 scopes, toewijzing per key | Alleen read-only vs read-write | Beperkte scope-controle |
| Webhookaflevering | HMAC-SHA256-getekend, auto-retry, SIEM-modus | Niet beschikbaar | Niet beschikbaar |
| Interne gRPC-API | Ja - edge naar core, low-latency interne calls | Alleen REST | Alleen REST |
Vragen over API & SDK's
Is de API versioned? Hoe werken breaking changes?
Ja. De huidige versie is v1, toegankelijk op /v1/... Breaking changes worden aangekondigd in de changelog met een deprecation-venster van 90 dagen voordat het oude gedrag wordt verwijderd. Niet-brekende toevoegingen (nieuwe velden, nieuwe optionele parameters) verschijnen zonder versiebump. De API-versie is stabiel; als v2 ooit wordt geïntroduceerd, draait v1 minstens 12 maanden parallel door. De OpenAPI-spec op /openapi.json weerspiegelt altijd de huidige stabiele versie.
Welke authenticatiemethode gebruikt de API?
Bearer token-authenticatie: neem je API-key op in de Authorization-header als 'Bearer elido_sk_...'. De keywaarde wordt eenmalig getoond bij het aanmaken. Voor server-naar-server webhookcalls van Elido naar jouw systeem tekent Elido de requestbody met HMAC-SHA256 via een gedeeld secret - verifieer de X-Elido-Signature-header in je webhookhandler. OAuth2 client credentials zijn beschikbaar voor partnerintegraties waar distributie van workspace API-keys onpraktisch is - neem contact met ons op voor OAuth2-partneronboarding.
Werkt de TypeScript-SDK in Cloudflare Workers en edge-runtimes?
Ja. De TypeScript-SDK gebruikt de fetch-API (beschikbaar in alle moderne edge-runtimes) en vermijdt Node.js-only-API's (geen fs, geen http, geen Buffer). Hij is getest op Cloudflare Workers, Vercel Edge Functions en Deno Deploy. Draai je de SDK in een beperkte edge-omgeving, gebruik dan het lightweight importpad (@elido/sdk/edge), dat de CLI-hulpprogramma's en Node.js-only-modules uitsluit van de bundel.
Hoe gebruik ik de MCP-server met Claude of ChatGPT?
Voor Claude: voeg de MCP-server toe aan je claude_desktop_config.json met je API-key als omgevingsvariabele - de Elido MCP-documentatie heeft een kopieerbaar configuratieblok. Voor ChatGPT (function calling): de MCP-server toont een JSON Schema-toolmanifest op /.well-known/mcp.json dat je kunt importeren in de actieconfiguratie van je GPT. Voor Cursor: voeg de MCP-server toe als lokale tool in de instellingen van Cursor met npx @elido/mcp-server. Alle configuraties vereisen een geldige Elido API-key met de relevante scopes.
Wat is het paginatiemodel voor list-endpoints?
Alle list-endpoints gebruiken cursor-gebaseerde paginatie. Het antwoord bevat een next_cursor-veld (null als er geen volgende pagina's zijn). Geef de cursorwaarde door als de cursor-queryparameter in het volgende verzoek. Standaard paginagrootte is 50; maximum is 200. Cursor-gebaseerde paginatie is stabiel - het toevoegen of verwijderen van records tussen pagina's zorgt er niet voor dat items worden overgeslagen of herhaald, in tegenstelling tot offset-gebaseerde paginatie. De SDK's bevatten een auto-paginate-helper die items één voor één levert, ongeacht paginagrenzen.
Kan ik de API gebruiken om meerdere workspaces vanuit één client te beheren?
Ja. API-keys zijn workspace-scoped, maar je kunt keys voor meerdere workspaces bezitten. Het API-endpoint-prefix is /v1/workspaces/{workspace_id}/... - geef de workspace-ID van de doelworkspace door. Bouw je een multi-workspace-beheertool (bijvoorbeeld een agencyportal die klantworkspaces beheert), dan houd je één API-key per workspace bij. OAuth2-partnercredentials met cross-workspace-scope zijn beschikbaar voor platformintegraties - neem contact op met sales.
Wat is de rate limit op het gratis plan en hoe wordt die gehandhaafd?
Gratis plan: 60 verzoeken per minuut per workspace. De rate limit wordt gehandhaafd bij de API-gateway met een token bucket-algoritme. Is de bucket leeg, dan geeft de API HTTP 429 terug met een Retry-After-header die aangeeft wanneer het volgende token beschikbaar is. De SDK's respecteren Retry-After automatisch bij 429-responses. Let op dat bulk-endpoints afzonderlijke limieten hebben - het bulk-create-endpoint voor links telt als één verzoek, ongeacht hoeveel links de payload bevat.
Is er een sandbox- of testomgeving?
Ja - geef de header X-Elido-Sandbox: true door aan elk API-verzoek om het tegen de sandboxomgeving te draaien. Sandboxverzoeken creëren echte objecten in een sandboxed workspace-partitie (links, campagnes, enz.), maar redirectverkeer wordt niet vanuit de productie-edge geserveerd. Gebruik de sandbox voor integratietests en CI/CD-pipelines. Sandboxobjecten tellen niet mee voor de link- of clickquota van je plan. De sandbox reset elke 24 uur - vertrouw niet op sandboxdata voor productiegebruik.
Verder lezen
HMAC-getekende uitgaande eventaflevering - het asynchrone complement van de synchrone API.
De API-resource die je het vaakst aanroept - maak, werk bij en query short links programmatisch.
Query click-events en aggregaten via de analytics-API - dezelfde data als het analyticsdashboard.
De developergerichte oplossingspagina - REST, SDK's, webhooks en het overzicht van de developer-ervaring.
Klaar om het te proberen?
Begin met het gratis plan, upgrade wanneer je een custom domain nodig hebt.