º Envie o nome de utilizador e o segredo da sua credencial para o endpoint do token. Esta troca não necessita de um token ao portador. Utilize o token de acesso devolvido como token de portador em pedidos REST subsequentes.
password: º Este campo JSON contém o segredo da sua credencial API, e não a palavra-passe de login da sua conta.
º Faça o seu primeiro pedido
º Execute o exemplo localmente. Solicita a 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 utilizam o endereço da API Cloud. Nunca cole segredos reais em documentação, tickets de suporte ou registos partilhados.
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 devolve os campos abaixo. O token aqui apresentado é 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 têm a duração de 30 minutos. Esta troca não devolve um token de atualização. Quando um token expirar, troque novamente a credencial. Para uma gravação interrompida, verifique o seu resultado e as regras de nova tentativa do endpoint antes de a reenviar.
º Escolha onde o token de acesso pode ser utilizado
audience: "api"- º Utilize este valor para pedidos de API REST. É o predefinido quando o campo de público é omitido.
audience: "mcp"- º Utilize este valor apenas 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 utilizados de forma intercambiável.
Se a autenticação falhar
- 401
- º Verifique o nome de utilizador e o segredo, a expiração e a revogação da credencial. Num pedido autenticado, 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 estas 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 é de 10 por IP de origem por minuto em cada Relay. As definições da plataforma podem alterar este limite.