Ξεκινήστε

Ενεργοποιήστε την πρόσβαση, δημιουργήστε ένα διαπιστευτήριο και κάντε το πρώτο σας αίτημα API.

1. Ενεργοποιήστε την πρόσβαση API

   Ένας Κάτοχος Οργανισμού ενεργοποιεί την πρόσβαση API και MCP στις Ρυθμίσεις. Το κοινόχρηστο πρόσθετο κοστίζει 20 δολάρια ΗΠΑ ανά οργανισμό ανά ημερολογιακό μήνα για εγκαταστάσεις Cloud και συνδεδεμένες εγκαταστάσεις Self-Hosted. Κατά τη διάρκεια μιας δοκιμαστικής περιόδου, οι Ρυθμίσεις δείχνουν εάν περιλαμβάνεται η πρόσβαση API και MCP. Εάν εμφανίζεται Περιλαμβάνεται στη δοκιμαστική περίοδο, ενεργοποιήστε την πρόσβαση εκεί. Διαφορετικά, ελέγξτε την επιλογή ενεργοποίησης επί πληρωμή. Η απενεργοποίηση της πρόσβασης επί πληρωμή δεν καταργεί τη χρέωση του τρέχοντος μήνα.

   Για Self-Hosted, ενεργοποιήστε το πρόσθετο στον οργανισμό Cloud που σας ανήκει, αφήστε την εγκατάσταση να ολοκληρώσει το check-in της άδειας χρήσης και, στη συνέχεια, ενεργοποιήστε την πρόσβαση API στις Ρυθμίσεις της εγκατάστασης. Χρησιμοποιήστε τη διεύθυνση HTTPS της εγκατάστασης αντί για τη διεύθυνση Cloud API σε αυτά τα παραδείγματα.

2. Δημιουργήστε ένα διαπιστευτήριο

   Δημιουργήστε ένα διαπιστευτήριο API στις Ρυθμίσεις. Ξεκινήστε με το Απόθεμα μόνο για αυτήν την αναλυτική παρουσίαση. Επιλέξτε ολόκληρο τον οργανισμό ή μία εταιρεία ως αντικείμενο. Το πεδίο δεν μπορεί να αλλάξει αργότερα. δημιουργήστε ένα νέο διαπιστευτήριο εάν χρειάζεστε διαφορετικό εύρος.

3. Αποθηκεύστε το μυστικό

   Ένα διαπιστευτήριο API έχει ένα όνομα χρήστη και ένα μυστικό. Το μυστικό εμφανίζεται μόνο όταν το δημιουργείτε ή το περιστρέφετε. Αποθηκεύστε το σε έναν διαχειριστή κωδικών πρόσβασης ή σε κατάστημα μυστικών. Είναι επαναχρησιμοποιήσιμο μέχρι να ανακληθεί ή να λήξει. δεν είναι ένας κωδικός επαλήθευσης μιας χρήσης ή ο κωδικός σύνδεσής σας.

4. Κάντε το πρώτο σας αίτημα

   Εκτελέστε το παράδειγμα τοπικά. Σας ζητά τα διαπιστευτήριά σας, λαμβάνει ένα διακριτικό πρόσβασης και παραθέτει την πρώτη σελίδα των συσκευών. Κρατήστε το διακριτικό ιδιωτικό. Αυτές οι σελίδες τεκμηρίωσης δεν ζητούν και δεν αποθηκεύουν ποτέ διαπιστευτήρια.

   Επιλέξτε μια γλώσσα και εγκαταστήστε τις εξαρτήσεις που αναφέρονται παρακάτω. Τα παραδείγματα χρησιμοποιούν τη διεύθυνση Cloud API. Ποτέ μην επικολλάτε πραγματικά μυστικά σε τεκμηρίωση, εισιτήρια υποστήριξης ή κοινόχρηστα αρχεία καταγραφής.

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

Πιστοποίηση →

Άδειες και πεδίο εφαρμογής

Μια προεπιλογή επιλέγει δυνατότητες, όχι επίπεδο πρόσβασης. Οι ρυθμίσεις δημιουργούν νέα διαπιστευτήρια με το FullAccess. οι επιλεγμένες δυνατότητες εξακολουθούν να περιορίζουν την πρόσβαση. Ελέγξτε τα προσαρμοσμένα δικαιώματα πριν από την αποθήκευση. Τα ReadOnly και ReadWrite περιγράφουν παλαιότερα ή ξεχωριστά δημιουργημένα διαπιστευτήρια, όχι προεπιλογές ονομάτων.

Οργάνωση, εταιρεία και τοποθεσία

Ένας οργανισμός είναι το όριο ανώτατου επιπέδου του λογαριασμού σας. Οι εταιρείες χωρίζουν πελάτες ή επιχειρηματικές μονάδες σε αυτό. Οι ιστότοποι ομαδοποιούν συσκευές σε μια εταιρεία. Ένα διαπιστευτήριο εύρους εταιρείας δεν μπορεί να έχει πρόσβαση στα δεδομένα άλλης εταιρείας.