API & SDKs. Build on Elido, in any language.

Sim. A versão atual é v1, acessada em /v1/... Mudanças que quebram compatibilidade são anunciadas no changelog com uma janela de depreciação de 90 dias antes que o comportamento antigo seja removido. Adições sem quebra de compatibilidade (novos campos, novos parâmetros opcionais) são lançadas sem incremento de versão. A versão da API é estável; se uma v2 for introduzida, a v1 funcionará em paralelo por pelo menos 12 meses. A especificação OpenAPI em /openapi.json sempre reflete a versão estável atual.

Autenticação por Bearer token: inclua sua chave de API no cabeçalho de Authorization como 'Bearer elido_sk_...'. O valor da chave é exibido uma vez na criação. Para chamadas de webhook de servidor para servidor do Elido para seu sistema, o Elido assina o corpo da requisição com HMAC-SHA256 usando um segredo compartilhado — verifique o cabeçalho X-Elido-Signature no seu handler de webhook. Credenciais OAuth2 client credentials estão disponíveis para integrações de parceiros onde a distribuição de chaves de API de workspace é impraticável — entre em contato para onboarding de parceiro OAuth2.

Sim. O SDK TypeScript usa a fetch API (disponível em todos os runtimes de edge modernos) e evita APIs exclusivas do Node.js (sem fs, sem http, sem Buffer). É testado no Cloudflare Workers, Vercel Edge Functions e Deno Deploy. Se você estiver executando o SDK em um ambiente de edge restrito, use o caminho de importação leve (@elido/sdk/edge), que exclui os utilitários de CLI e módulos exclusivos do Node.js do bundle.

Para Claude: adicione o servidor MCP ao seu claude_desktop_config.json com sua chave de API como variável de ambiente — a documentação MCP do Elido tem uma configuração de copiar e colar em um único bloco. Para ChatGPT (function calling): o servidor MCP expõe um manifesto de ferramentas JSON Schema em /.well-known/mcp.json que você pode importar para a configuração de ação do seu GPT. Para Cursor: adicione o servidor MCP como ferramenta local nas configurações do Cursor com npx @elido/mcp-server. Todas as configurações requerem uma chave de API Elido válida com os escopos relevantes.

Todos os endpoints de listagem usam paginação baseada em cursor. A resposta inclui um campo next_cursor (null se não houver mais páginas). Passe o valor do cursor como parâmetro de consulta cursor na próxima requisição. O tamanho de página padrão é 50; o máximo é 200. A paginação baseada em cursor é estável — adicionar ou excluir registros entre páginas não faz itens serem pulados ou repetidos, ao contrário da paginação baseada em offset. Os SDKs incluem um helper de auto-paginação que retorna itens um por vez, independentemente dos limites de página.

Sim. As chaves de API têm escopo de workspace, mas você pode manter chaves para múltiplos workspaces. O prefixo do endpoint da API é /v1/workspaces/{workspace_id}/... — passe o ID do workspace alvo. Se você estiver construindo uma ferramenta de gerenciamento multi-workspace (ex.: um portal de agência gerenciando workspaces de clientes), você manterá uma chave de API por workspace. Credenciais de parceiro OAuth2 com escopo cross-workspace estão disponíveis para integrações de plataforma — entre em contato com vendas.

Plano Free: 60 requisições por minuto por workspace. O limite de taxa é aplicado no gateway de API com um algoritmo de token bucket. Quando o bucket está vazio, a API retorna HTTP 429 com um cabeçalho Retry-After indicando quando o próximo token estará disponível. Os SDKs respeitam automaticamente o Retry-After em respostas 429. Observe que os endpoints em massa têm limites separados — o endpoint de criação em massa de links conta como uma requisição independentemente de quantos links estão no payload.

Sim — passe o cabeçalho X-Elido-Sandbox: true em qualquer requisição de API para executá-la no ambiente sandbox. Requisições sandbox criam objetos reais em uma partição de workspace sandboxada (links, campanhas, etc.), mas o tráfego de redirect não é servido a partir do edge de produção. Use o sandbox para testes de integração e pipelines de CI/CD. Os objetos sandbox não contam para as cotas de links ou cliques do seu plano. O sandbox é reiniciado a cada 24 horas — não dependa de dados do sandbox para uso em produção.