Autenticação (API v1, removida)
Os endpoints por chave da API v1 não funcionam mais
Eles respondem 410 Gone. Use a API v2: a chave vai em Authorization: Bearer <key> e o espaço de trabalho no cabeçalho X-Workspace-Id. Esta página é mantida apenas para ajudar na migração. Veja para onde cada endpoint foi movido.
Todos os endpoints de gerenciamento da API v1 exigiam autenticação por chave de API. Cada requisição deve conter duas coisas: uma chave de API no cabeçalho e um Workspace ID no corpo da requisição ou na query string.
URL base
https://api.revolink.link/apiv1/
Como obter suas credenciais
- Abra o aplicativo Revolink e vá em Perfil → Integrações.
- Clique em Gerar chave de API. Copie e guarde a chave: ela é exibida apenas uma vez. Se você a perder, gere uma nova (a antiga é invalidada imediatamente).
- Copie o seu Workspace ID na mesma página.
Enviar a chave de API
Envie a chave no cabeçalho X-Api-Key em cada requisição:
X-Api-Key: rvlnk_your_api_key_here
Enviar o Workspace ID
Inclua workspaceId em cada requisição:
- POST / PUT / DELETE: no corpo JSON da requisição.
- GET: como parâmetro de consulta.
bash
# POST example
curl -X POST https://api.revolink.link/apiv1/link/create \
-H "Content-Type: application/json" \
-H "X-Api-Key: rvlnk_your_api_key_here" \
-d '{
"workspaceId": "your_workspace_id",
"name": "My link",
"rules": [
{
"id": "rule-1",
"targetUrl": "https://example.com",
"isDefault": true
}
]
}'
Erros de autenticação
| Status HTTP | Corpo da resposta | Causa |
|---|---|---|
401 | {"error": "API key is required. Pass it in the X-Api-Key header."} | O cabeçalho X-Api-Key está ausente |
401 | {"error": "Invalid API key."} | A chave não corresponde a nenhum usuário |
400 | {"error": "workspaceId is required."} | workspaceId não foi informado |
400 | {"error": "Invalid workspaceId format."} | workspaceId não é um ObjectId válido |
404 | {"error": "Workspace not found."} | Não existe espaço de trabalho com esse ID |
403 | {"error": "You do not have access to this workspace."} | O dono da chave de API não é membro nem proprietário do espaço de trabalho |
403 | {"licenseExpired": true, "error": "The workspace license has expired."} | O plano do espaço de trabalho expirou |
Corpos das respostas
Os corpos das respostas da API estão sempre em inglês, como o servidor os devolve. Aqui só a coluna «Causa» é traduzida.