Başlayın

Erişimi etkinleştirin, bir kimlik bilgisi oluşturun ve ilk API isteğinizi yapın.

1. API erişimini açın

   Kuruluş Sahibi, Ayarlar'da API ve MCP erişimini etkinleştirir. Paylaşılan eklenti, Bulut ve bağlantılı Kendi Kendine Barındırılan kurulumlar için kuruluş başına aylık 20 ABD doları tutarındadır. Deneme süresi boyunca, Ayarlar, API ve MCP erişiminin dahil olup olmadığını gösterir. Denemeye dahil olduğunu gösteriyorsa, erişimi orada etkinleştirin; aksi takdirde ücretli etkinleştirme seçeneğini inceleyin. Ücretli erişimi devre dışı bırakmak, mevcut ayın ücretini kaldırmaz.

   Kendi Kendine Barındırılan için, sahip olduğunuz Bulut kuruluşunuzda eklentiyi etkinleştirin, kurulumun lisans girişini tamamlamasına izin verin ve ardından kurulumun Ayarlar bölümünde API erişimini etkinleştirin. Bu örneklerde Cloud API adresi yerine kurulumun kendi HTTPS adresini kullanın.

2. Kimlik bilgisi oluşturun

   Ayarlar'da bir API kimlik bilgisi oluşturun. Yalnızca bu izlenecek yol için Envanter ile başlayın. Kapsam olarak tüm organizasyonu veya bir şirketi seçin. Kapsam sonradan değiştirilemez; Farklı bir kapsama ihtiyacınız varsa yeni bir kimlik bilgisi oluşturun.

3. Sırrı kaydedin

   API kimlik bilgilerinin bir kullanıcı adı ve bir sırrı vardır. Sır yalnızca onu oluşturduğunuzda veya döndürdüğünüzde gösterilir. Bunu bir şifre yöneticisine veya sırlar deposuna kaydedin. İptal edilene veya süresi dolana kadar yeniden kullanılabilir; tek seferlik bir doğrulama kodu veya giriş şifreniz değildir.

4. İlk isteğinizi yapın

   Örneği yerel olarak çalıştırın. Kimlik bilgilerinizi ister, bir erişim belirteci alır ve cihazların ilk sayfasını listeler. Belirteci gizli tutun. Bu belge sayfaları hiçbir zaman kimlik bilgilerini istemez veya saklamaz.

   Bir dil seçin ve aşağıda listelenen bağımlılıkları yükleyin. Örneklerde Cloud API adresi kullanılmaktadır. Hiçbir zaman gerçek sırları belgelere, destek biletlerine veya paylaşılan günlüklere yapıştırmayın.

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

Kimlik doğrulama →

İzinler ve kapsam

Bir ön ayar, erişim düzeyini değil, yetenekleri seçer. Ayarlar, FullAccess ile yeni kimlik bilgileri oluşturur; seçilen yetenekler yine de erişimi kısıtlar. Kaydetmeden önce özel izinleri gözden geçirin. ReadOnly ve ReadWrite, ön ayar adlarını değil, eski veya ayrı olarak oluşturulmuş kimlik bilgilerini tanımlar.

Organizasyon, şirket ve site

Organizasyon, hesabınızın üst düzey sınırıdır. Şirketler kendi içindeki müşterileri veya iş birimlerini ayırır. Siteler bir şirket içindeki cihazları gruplandırır. Şirket kapsamlı bir kimlik bilgisi başka bir şirketin verilerine erişemez.