O que você vai fazer
- Emitir uma chave de API com escopos em Settings → API keys — o token é exibido apenas uma vez, copie imediatamente.
- Encurtar um link com uma chamada de SDK ou um único comando
curlem menos de um minuto. - Usar chaves de idempotência em requisições mutantes para que as tentativas nunca criem links duplicados.
A API Elido é REST + JSON, documentada com OpenAPI 3.1 e possui limite de taxa por chave. Oferecemos SDKs oficiais para TypeScript, Go e Python que a envolvem. O servidor MCP em @elido/mcp-server expõe a mesma superfície para agentes de IA.
Emitir uma chave de API#
- Settings → API keys → Create key.
- Escolha um nome (recomendamos o sistema que irá utilizá-la:
zapier,internal-billing,marketing-cli). - Escolha os escopos. Os quatro comuns são:
links:read— listar e inspecionar links.links:write— criar, atualizar e excluir links.analytics:read— consultar eventos de clique.webhooks:write— gerenciar assinaturas de webhook.
- Clique em Create. A chave é exibida apenas uma vez — armazenamos apenas um hash.
Se você perder uma chave, revogue-a na mesma página e emita uma nova. Chaves revogadas são rejeitadas em até 60 segundos em todas as regiões.
Início rápido com o SDK TypeScript#
import { ElidoClient } from "@elido/sdk";
const client = new ElidoClient({ apiKey: process.env.ELIDO_API_KEY! });
const link = await client.links.create({
destination: "https://acme.com/spring-sale",
slug: "spring-2026",
});
console.log(link.short_url);
Os SDKs Go e Python seguem o mesmo formato. Referência completa em /api.
Início rápido com curl#
curl -X POST https://api.elido.app/v1/links \
-H "Authorization: Bearer $ELIDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"destination":"https://acme.com/spring-sale","slug":"spring-2026"}'
Limites de taxa#
O plano gratuito recebe 60 requisições por minuto por chave. Pro: 600/min. Business: 6000/min. O burst é 2× o limite de estado estável; o cabeçalho de resposta X-RateLimit-Remaining informa sua situação atual.
Se você atingir o limite, a API retorna 429 com Retry-After definido. Os SDKs implementam a tentativa de reenvio com exponential-backoff por padrão — desative-o se seu aplicativo gerencia sua própria política de reenvio.
Idempotência#
Endpoints de mutação aceitam um cabeçalho Idempotency-Key. Passe um UUID para cada gravação pretendida; armazenamos a resposta em cache por 24 horas para que as tentativas de reenvio (erros de rede, timeouts ambíguos) não criem duplicatas.
Os SDKs adicionam o cabeçalho automaticamente. Se estiver usando curl diretamente, gere a chave no lado do cliente e inclua-a em cada tentativa.
Webhooks#
Para notificações em tempo real em vez de polling, configure webhooks em Settings → Webhooks — entregamos eventos link.created, link.clicked.aggregated e domain.verified com assinaturas HMAC-SHA256.