Autenticação #

Toda requisição à API v2 precisa de duas coisas: uma chave de API e o espaço de trabalho em que ela atua.

URL base #

https://api.revolink.link/apiv2

A especificação OpenAPI 3.1 está em https://api.revolink.link/apiv2/openapi.json e a documentação interativa em https://api.revolink.link/apiv2/docs.

Como obter suas credenciais #

1. Abra o aplicativo Revolink e vá em Perfil → API.
2. Crie uma chave de API e escolha as permissões de que ela precisa. Copie a chave: ela é exibida apenas uma vez.
3. Copie o ID do seu espaço de trabalho.

Enviar a chave de API #

Envie a chave como token Bearer. O cabeçalho X-Api-Key também é aceito.

Authorization: Bearer rvlnk_your_api_key_here

Enviar o espaço de trabalho #

Envie o ID do espaço de trabalho no cabeçalho X-Workspace-Id em toda requisição. O dono da chave deve ser membro do espaço de trabalho.

Diferente da API v1, o espaço de trabalho é lido somente deste cabeçalho, nunca do corpo da requisição nem da query string.

curl https://api.revolink.link/apiv2/me \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id"

GET /me retorna o usuário, o espaço de trabalho e as permissões da chave, então é uma boa primeira requisição para conferir sua configuração.

Permissões #

Uma chave tem permissões (scopes). Um endpoint responde 403 com error.requiredPermission quando a chave não tem a permissão de que ele precisa.

Limite de requisições #

300 requisições por minuto por chave de API. Acima do limite, a API responde 429 com o cabeçalho Retry-After.

Veja Erros para o formato e os códigos de erro.