Empieza

Habilite el acceso, cree una credencial y realice su primera solicitud de API.

1. Active el acceso API

   El propietario de la organización habilita el acceso a API y MCP en Configuración. El complemento compartido tiene un costo de US$20 por organización por mes calendario para instalaciones en la nube y autoalojadas vinculadas. Durante el período de prueba, Configuración muestra si el acceso a API y MCP está incluido. Si aparece "Incluido en la prueba", habilítelo allí; de lo contrario, revise la opción de activación de pago. Deshabilitar el acceso de pago no elimina el cargo del mes en curso.

   Para autohospedado, habilite el complemento en su organización de nube propietaria, deje que la instalación complete su registro de licencia y luego habilite el acceso API en la configuración de la instalación. Utilice la dirección HTTPS propia de la instalación en lugar de la dirección de la API de la nube en estos ejemplos.

2. Crea una credencial

   Cree una credencial API en Configuración. Comience solo con Inventario para este tutorial. Elija toda la organización o una empresa como alcance. El alcance no se puede cambiar más adelante; cree una nueva credencial si necesita un alcance diferente.

3. Guarda el secreto

   Una credencial API tiene un nombre de usuario y un secreto. El secreto se muestra solo cuando lo creas o lo rotas. Guárdelo en un administrador de contraseñas o en una tienda de secretos. Es reutilizable hasta que sea revocado o caduque; no es un código de verificación único ni su contraseña de inicio de sesión.

4. Haz tu primera solicitud

   Ejecute el ejemplo localmente. Solicita su credencial, obtiene un token de acceso y enumera la primera página de dispositivos. Mantenga el token en privado. Estas páginas de documentación nunca solicitan ni almacenan credenciales.

   Elija un idioma e instale las dependencias que se enumeran a continuación. Los ejemplos utilizan la dirección de la API de la nube. Nunca pegue secretos reales en documentación, tickets de soporte o registros compartidos.

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

Autenticación →

Permisos y alcance

Un valor preestablecido selecciona capacidades, no un nivel de acceso. La configuración crea nuevas credenciales con FullAccess; las capacidades seleccionadas aún restringen el acceso. Revise los permisos personalizados antes de guardar. ReadOnly y ReadWrite describen credenciales más antiguas o creadas por separado, no nombres preestablecidos.

Organización, empresa y sitio

Una organización es el límite de nivel superior de su cuenta. Las empresas separan clientes o unidades de negocio dentro de ella. Los sitios agrupan dispositivos dentro de una empresa. Una credencial de ámbito empresarial no puede acceder a los datos de otra empresa.