Envie o nome de usuário e o segredo da sua credencial para o endpoint do token. Esta troca não precisa de um token ao portador. Use o token de acesso retornado como token de portador em solicitações REST subsequentes.
password: Este campo JSON contém o segredo da sua credencial da API, não a senha de login da sua conta.
Faça seu primeiro pedido
Execute o exemplo localmente. Ele solicita sua credencial, obtém um token de acesso e lista a primeira página de dispositivos. Mantenha o token privado. Estas páginas de documentação nunca solicitam ou armazenam credenciais.
Escolha um idioma e instale as dependências listadas abaixo. Os exemplos usam o endereço da API Cloud. Nunca cole segredos reais em documentação, tickets de suporte ou registros compartilhados.
cURL: Bash + jq · Python: requests · C#: .NET 8+ (HttpClient)
C#: dotnet new console → Program.cs → dotnet run
$credential = Get-Credential
$body = @{
username = $credential.UserName
password = $credential.GetNetworkCredential().Password
audience = "api"
} | ConvertTo-Json
$token = Invoke-RestMethod -Method Post -Uri "https://api.remotegymp.com/v1/auth/token" -ContentType "application/json" -Body $body
$env:RG_API_TOKEN = $token.accessToken
Invoke-RestMethod -Uri "https://api.remotegymp.com/v1/devices?pageSize=25" -Headers @{ Authorization = "Bearer $env:RG_API_TOKEN" }Resposta do token de acesso
A troca de credenciais retorna os campos abaixo. O token mostrado aqui é um espaço reservado. O tempo de vida está em segundos e o carimbo de data/hora de expiração é UTC.
{
"accessToken": "<access-token>",
"tokenType": "Bearer",
"expiresIn": 1800,
"expiresAtUtc": "2026-10-26T12:30:00Z"
}Os tokens emitidos por credenciais duram 30 minutos. Esta troca não retorna um token de atualização. Quando um token expirar, troque a credencial novamente. Para uma gravação interrompida, verifique seu resultado e as regras de nova tentativa do endpoint antes de reenviá-la.
Escolha onde o token de acesso pode ser usado
audience: "api"- Use este valor para solicitações de API REST. É o padrão quando o campo de público é omitido.
audience: "mcp"- Use esse valor somente para um cliente MCP configurado com um token de acesso. A credencial deve ter o MCP ativado. Os tokens API e MCP não podem ser usados de forma intercambiável.
Se a autenticação falhar
- 401
- Verifique o nome de usuário e segredo, expiração e revogação da credencial. Em uma solicitação autenticada, verifique também a expiração e o público do token. Repetir a mesma credencial inválida não resolverá o problema.
- 403
- Verifique o código de resposta e a mensagem. O acesso pode ser bloqueado por permissões, política de rede ou país, acesso atual do Proprietário ou elegibilidade de complemento. Um novo token não ignora essas verificações.
- 429 ·
Retry-After - Aguarde o atraso indicado no cabeçalho da resposta antes de tentar novamente. O limite padrão de tentativas de token é 10 por IP de origem por minuto em cada Relay. As configurações da plataforma podem alterar esse limite.