Commencez

Activez l'accès, créez un identifiant et effectuez votre première demande API.

1. Activez l'accès à l'API

   Le propriétaire de l'organisation active l'accès aux API et MCP dans les Paramètres. Ce module complémentaire partagé coûte 20 $ US par organisation et par mois calendaire pour les installations Cloud et les installations auto-hébergées liées. Pendant la période d'essai, les Paramètres indiquent si l'accès aux API et MCP est inclus. Si c'est le cas, activez l'accès ; sinon, consultez l'option d'activation payante. La désactivation de l'accès payant n'annule pas la facturation du mois en cours.

   Pour l'auto-hébergé, activez le module complémentaire dans votre organisation Cloud propriétaire, laissez l'installation terminer l'enregistrement de sa licence, puis activez l'accès à l'API dans les paramètres de l'installation. Utilisez la propre adresse HTTPS de l'installation au lieu de l'adresse de l'API Cloud dans ces exemples.

2. Créez un identifiant

   Créez un identifiant API dans Paramètres. Commencez par Inventaire uniquement pour cette procédure pas à pas. Choisissez l’ensemble de l’organisation ou une entreprise comme périmètre. La portée ne peut pas être modifiée ultérieurement ; créez un nouvel identifiant si vous avez besoin d'une portée différente.

3. Gardez le secret

   Un identifiant API a un nom d'utilisateur et un secret. Le secret s'affiche uniquement lorsque vous le créez ou le faites pivoter. Enregistrez-le dans un gestionnaire de mots de passe ou un magasin de secrets. Il est réutilisable jusqu'à sa révocation ou son expiration ; il ne s'agit pas d'un code de vérification à usage unique ni de votre mot de passe de connexion.

4. Faites votre première demande

   Exécutez l'exemple localement. Il vous demande vos informations d'identification, obtient un jeton d'accès et répertorie la première page des appareils. Gardez le jeton privé. Ces pages de documentation ne demandent ni ne stockent jamais d’informations d’identification.

   Choisissez une langue et installez les dépendances répertoriées ci-dessous. Les exemples utilisent l'adresse de l'API Cloud. Ne collez jamais de vrais secrets dans la documentation, les tickets d’assistance ou les journaux partagés.

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

Authentification →

Autorisations et portée

Un préréglage sélectionne des fonctionnalités, et non un niveau d'accès. Les paramètres créent de nouvelles informations d'identification avec FullAccess ; les fonctionnalités sélectionnées restreignent toujours l'accès. Vérifiez les autorisations personnalisées avant d'enregistrer. ReadOnly et ReadWrite désignent des informations d'identification plus anciennes ou créées séparément, et non des noms de préréglages.

Organisation, entreprise et site

Une organisation constitue la limite de niveau supérieur de votre compte. Les entreprises séparent les clients ou les unités commerciales en leur sein. Les sites regroupent les appareils au sein d’une entreprise. Un identifiant d'entreprise ne peut pas accéder aux données d'une autre entreprise.