º Comece

º Ative o acesso, crie uma credencial e faça o seu primeiro pedido de API.

1. º Ative o acesso à API

   O proprietário da organização ativa o acesso API e MCP nas Definições. O complemento partilhado custa 20 dólares por organização por mês civil para instalações na nuvem e auto-hospedadas ligadas. Durante o período de avaliação, as Definições mostram se o acesso API e MCP está incluído. Se estiver indicado "Incluído na avaliação", ative o acesso aí; caso contrário, reveja a opção de ativação paga. A desativação do acesso pago não remove a cobrança do mês atual.

   Para auto-hospedado, ative o complemento na sua organização de cloud proprietária, deixe a instalação concluir o check-in da licença e, em seguida, ative o acesso à API nas definições da instalação. Utilize o endereço HTTPS da própria instalação em vez do endereço da Cloud API nestes exemplos.

2. º Crie uma credencial

   º Crie uma credencial API em Definições. Comece pelo Inventário apenas para este passo a passo. Escolha toda a organização ou uma empresa como âmbito. O âmbito não pode ser alterado posteriormente; crie uma nova credencial se necessitar de um âmbito diferente.

3. º Guarde o segredo

   Um credencial API possui um nome de utilizador e um segredo. O segredo é mostrado apenas quando o cria ou gira. Guarde-o num gestor de senhas ou armazenamento de segredos. É reutilizável até ser revogado ou expirar; não é um código de verificação único ou a sua palavra-passe de login.

4. º 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" }

Autenticação →

Permissões e âmbito

Uma predefinição seleciona recursos, e não um nível de acesso. As definições criam novas credenciais com FullAccess; os recursos selecionados ainda restringem o acesso. Reveja as permissões personalizadas antes de guardar. ReadOnly e ReadWrite descrevem credenciais mais antigas ou criadas separadamente, e não nomes de predefinições.

Organização, empresa e site

º Uma organização é o limite de nível superior da sua conta. As empresas separam os clientes ou as unidades de negócio dentro dela. Os sites agrupam os dispositivos dentro de uma empresa. Uma credencial no âmbito da empresa não pode aceder aos dados de outra empresa.