Uwierzytelnianie

Wyślij nazwę użytkownika i sekret swojego poświadczenia do punktu końcowego tokenu. Ta giełda nie wymaga tokena na okaziciela. Użyj zwróconego tokenu dostępu jako tokenu okaziciela w kolejnych żądaniach REST.

password: To pole JSON zawiera sekret danych uwierzytelniających API, a nie hasło logowania do konta.

Złóż swoją pierwszą prośbę

Uruchom przykład lokalnie. Monituje o podanie danych uwierzytelniających, uzyskuje token dostępu i wyświetla pierwszą stronę urządzeń. Zachowaj token jako prywatny. Te strony dokumentacji nigdy nie proszą o podanie danych uwierzytelniających ani ich nie przechowują.

Wybierz język i zainstaluj zależności wymienione poniżej. W przykładach używany jest adres Cloud API. Nigdy nie wklejaj prawdziwych sekretów do dokumentacji, zgłoszeń do pomocy technicznej ani udostępnianych dzienników.

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

Odpowiedź na token dostępu

Wymiana danych uwierzytelniających zwraca poniższe pola. Pokazany tutaj token jest symbolem zastępczym. Czas życia podany jest w sekundach, a znacznik czasu wygaśnięcia to UTC.

{
  "accessToken": "<access-token>",
  "tokenType": "Bearer",
  "expiresIn": 1800,
  "expiresAtUtc": "2026-10-26T12:30:00Z"
}

Tokeny uwierzytelniające ważne są przez 30 minut. Ta wymiana nie zwraca tokena odświeżania. Kiedy token wygaśnie, wymień dane uwierzytelniające ponownie. W przypadku przerwanego zapisu sprawdź jego wynik i reguły ponawiania punktu końcowego przed ponownym przesłaniem.

Wybierz, gdzie może być używany token dostępu

audience: "api"

Użyj tej wartości dla żądań API REST. Jest to ustawienie domyślne, gdy pole odbiorców jest pominięte.

audience: "mcp"

Użyj tej wartości tylko w przypadku klienta MCP skonfigurowanego z tokenem okaziciela. Poświadczenie musi mieć włączone MCP. Tokenów API i MCP nie można używać zamiennie.

Jeśli uwierzytelnienie nie powiedzie się

401

Sprawdź nazwę użytkownika i sekret, wygaśnięcie i unieważnienie danych uwierzytelniających. W przypadku uwierzytelnionego żądania sprawdź także datę ważności tokena i odbiorców. Powtórzenie tych samych nieprawidłowych danych uwierzytelniających nie rozwiąże problemu.

403

Sprawdź kod odpowiedzi i komunikat. Dostęp może być blokowany przez uprawnienia, zasady sieci lub kraju, bieżący dostęp właściciela lub uprawnienia dodatku. Nowy token nie omija tych kontroli.

429 · Retry-After

Przed ponowną próbą poczekaj na opóźnienie podane w nagłówku odpowiedzi. Domyślny limit prób tokenu wynosi 10 na źródłowy adres IP na minutę w każdym przekaźniku. Ustawienia platformy mogą zmienić ten limit.

Referencje API → POST /v1/auth/token

Podłącz asystenta AI →