Comece

Habilite o acesso, crie uma credencial e faça sua primeira solicitação de API.

1. Ative o acesso à API

   O proprietário da organização habilita o acesso API e MCP nas Configurações. O complemento compartilhado custa US$ 20 por organização por mês civil para instalações na nuvem e auto-hospedadas vinculadas. Durante o período de avaliação, as Configurações mostram se o acesso API e MCP está incluído. Se estiver indicado "Incluído na avaliação", habilite o acesso lá; caso contrário, revise a opção de ativação paga. Desabilitar o acesso pago não remove a cobrança do mês atual.

   Para auto-hospedado, ative o complemento na sua organização de nuvem proprietária, deixe a instalação concluir o check-in da licença e, em seguida, ative o acesso à API nas configurações da instalação. Use 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 Configurações. Comece com o Inventário apenas para este passo a passo. Escolha toda a organização ou uma empresa como escopo. O escopo não pode ser alterado posteriormente; crie uma nova credencial se precisar de um escopo diferente.

3. Salve o segredo

   Uma credencial de API possui um nome de usuário e um segredo. O segredo é mostrado somente quando você o cria ou gira. Salve-o em um gerenciador de senhas ou armazenamento de segredos. É reutilizável até ser revogado ou expirar; não é um código de verificação único ou sua senha de login.

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

Autenticação →

Permissões e escopo

Uma predefinição seleciona recursos, não um nível de acesso. As configurações criam novas credenciais com FullAccess; os recursos selecionados ainda restringem o acesso. Revise as permissões personalizadas antes de salvar. ReadOnly e ReadWrite descrevem credenciais mais antigas ou criadas separadamente, 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 clientes ou unidades de negócios dentro dela. Os sites agrupam dispositivos dentro de uma empresa. Uma credencial no escopo da empresa não pode acessar os dados de outra empresa.