Skip to content
Nesta página

Referência da API

A versão atual é a API v2. URL base:

https://api.revolink.link/apiv2

Ela segue uma especificação OpenAPI 3.1: https://api.revolink.link/apiv2/openapi.json. Documentação interativa, onde você pode ver cada campo: https://api.revolink.link/apiv2/docs.

Início rápido

bash
curl -X POST https://api.revolink.link/apiv2/links \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com" }'

Ou com o SDK TypeScript:

ts
import {Revolink} from 'revolink';

const revolink = new Revolink({apiKey: process.env.REVOLINK_API_KEY!, workspaceId: process.env.REVOLINK_WORKSPACE_ID!});
const {shortLink} = await revolink.links.create({url: 'https://example.com'});

O que a API v2 oferece

AutenticaçãoChave de API, cabeçalho do espaço de trabalho, permissões, limite de requisições
LinksListar, criar, upsert, atualizar, excluir e operações em massa
AnálisesAnálises de cliques de um link ou de um espaço de trabalho
Tags e domíniosGerenciamento de tags e domínios próprios
Erros e respostasFormato de resposta, códigos de erro, paginação
SDK TypeScriptnpm install revolink

API v1

Os endpoints de gerenciamento por chave de API da API v1 (/apiv1/link/create e outros cinco) foram substituídos pela API v2 e agora respondem 410 Gone. Veja a API v1 para a lista e para onde cada um foi movido. Os endpoints públicos da v1 e o servidor MCP não são afetados.