ਪਹੁੰਚ ਨੂੰ ਸਮਰੱਥ ਬਣਾਓ, ਇੱਕ ਪ੍ਰਮਾਣ ਪੱਤਰ ਬਣਾਓ ਅਤੇ ਆਪਣੀ ਪਹਿਲੀ API ਬੇਨਤੀ ਕਰੋ।
API ਪਹੁੰਚ ਚਾਲੂ ਕਰੋ
ਇੱਕ ਸੰਗਠਨ ਮਾਲਕ ਸੈਟਿੰਗਾਂ ਵਿੱਚ API ਅਤੇ MCP ਪਹੁੰਚ ਨੂੰ ਸਮਰੱਥ ਬਣਾਉਂਦਾ ਹੈ। ਸਾਂਝਾ ਐਡ-ਆਨ ਕਲਾਉਡ ਅਤੇ ਲਿੰਕਡ ਸਵੈ-ਹੋਸਟਡ ਸਥਾਪਨਾਵਾਂ ਲਈ ਪ੍ਰਤੀ ਕੈਲੰਡਰ ਮਹੀਨੇ ਪ੍ਰਤੀ ਸੰਗਠਨ US$20 ਦੀ ਲਾਗਤ ਕਰਦਾ ਹੈ। ਇੱਕ ਟ੍ਰਾਇਲ ਦੌਰਾਨ, ਸੈਟਿੰਗਾਂ ਦਿਖਾਉਂਦੀਆਂ ਹਨ ਕਿ ਕੀ API ਅਤੇ MCP ਪਹੁੰਚ ਸ਼ਾਮਲ ਹੈ। ਜੇਕਰ ਇਹ ਟ੍ਰਾਇਲ ਵਿੱਚ ਸ਼ਾਮਲ ਦਿਖਾਉਂਦਾ ਹੈ, ਤਾਂ ਉੱਥੇ ਪਹੁੰਚ ਨੂੰ ਸਮਰੱਥ ਬਣਾਓ; ਨਹੀਂ ਤਾਂ ਭੁਗਤਾਨ ਕੀਤੀ ਐਕਟੀਵੇਸ਼ਨ ਵਿਕਲਪ ਦੀ ਸਮੀਖਿਆ ਕਰੋ। ਭੁਗਤਾਨ ਕੀਤੀ ਪਹੁੰਚ ਨੂੰ ਅਯੋਗ ਕਰਨ ਨਾਲ ਮੌਜੂਦਾ ਮਹੀਨੇ ਦਾ ਚਾਰਜ ਨਹੀਂ ਹਟਦਾ ਹੈ।
ਸਵੈ-ਮੇਜ਼ਬਾਨੀ ਲਈ, ਆਪਣੀ ਖੁਦ ਦੀ ਕਲਾਉਡ ਸੰਸਥਾ ਵਿੱਚ ਐਡ-ਆਨ ਨੂੰ ਸਮਰੱਥ ਬਣਾਓ, ਇੰਸਟਾਲੇਸ਼ਨ ਨੂੰ ਆਪਣਾ ਲਾਇਸੈਂਸ ਚੈੱਕ-ਇਨ ਪੂਰਾ ਕਰਨ ਦਿਓ, ਫਿਰ ਸਥਾਪਨਾ ਦੀਆਂ ਸੈਟਿੰਗਾਂ ਵਿੱਚ API ਪਹੁੰਚ ਨੂੰ ਸਮਰੱਥ ਬਣਾਓ। ਇਹਨਾਂ ਉਦਾਹਰਣਾਂ ਵਿੱਚ ਕਲਾਉਡ API ਪਤੇ ਦੀ ਬਜਾਏ ਇੰਸਟਾਲੇਸ਼ਨ ਦੇ ਆਪਣੇ HTTPS ਪਤੇ ਦੀ ਵਰਤੋਂ ਕਰੋ।
ਇੱਕ ਪ੍ਰਮਾਣ ਪੱਤਰ ਬਣਾਓ
ਸੈਟਿੰਗਾਂ ਵਿੱਚ ਇੱਕ API ਪ੍ਰਮਾਣ ਪੱਤਰ ਬਣਾਓ। ਇਸ ਵਾਕਥਰੂ ਲਈ ਸਿਰਫ਼ ਇਨਵੈਂਟਰੀ ਨਾਲ ਸ਼ੁਰੂ ਕਰੋ। ਪੂਰੀ ਸੰਸਥਾ ਜਾਂ ਇੱਕ ਕੰਪਨੀ ਨੂੰ ਇਸਦੇ ਦਾਇਰੇ ਵਜੋਂ ਚੁਣੋ। ਦਾਇਰਾ ਬਾਅਦ ਵਿੱਚ ਬਦਲਿਆ ਨਹੀਂ ਜਾ ਸਕਦਾ; ਜੇਕਰ ਤੁਹਾਨੂੰ ਇੱਕ ਵੱਖਰੇ ਸਕੋਪ ਦੀ ਲੋੜ ਹੈ ਤਾਂ ਇੱਕ ਨਵਾਂ ਪ੍ਰਮਾਣ ਪੱਤਰ ਬਣਾਓ।
ਰਾਜ਼ ਸੰਭਾਲੋ
ਇੱਕ API ਪ੍ਰਮਾਣ ਪੱਤਰ ਦਾ ਇੱਕ ਉਪਭੋਗਤਾ ਨਾਮ ਅਤੇ ਇੱਕ ਗੁਪਤ ਹੁੰਦਾ ਹੈ। ਰਾਜ਼ ਉਦੋਂ ਹੀ ਦਿਖਾਇਆ ਜਾਂਦਾ ਹੈ ਜਦੋਂ ਤੁਸੀਂ ਇਸਨੂੰ ਬਣਾਉਂਦੇ ਹੋ ਜਾਂ ਘੁੰਮਾਉਂਦੇ ਹੋ. ਇਸਨੂੰ ਪਾਸਵਰਡ ਮੈਨੇਜਰ ਜਾਂ ਸੀਕਰੇਟਸ ਸਟੋਰ ਵਿੱਚ ਸੇਵ ਕਰੋ। ਰੱਦ ਜਾਂ ਮਿਆਦ ਪੁੱਗਣ ਤੱਕ ਇਹ ਮੁੜ ਵਰਤੋਂ ਯੋਗ ਹੈ; ਇਹ ਇੱਕ ਵਾਰ ਦਾ ਪੁਸ਼ਟੀਕਰਨ ਕੋਡ ਜਾਂ ਤੁਹਾਡਾ ਲੌਗਇਨ ਪਾਸਵਰਡ ਨਹੀਂ ਹੈ।
ਆਪਣੀ ਪਹਿਲੀ ਬੇਨਤੀ ਕਰੋ
ਸਥਾਨਕ ਤੌਰ 'ਤੇ ਉਦਾਹਰਨ ਚਲਾਓ। ਇਹ ਤੁਹਾਡੇ ਪ੍ਰਮਾਣ ਪੱਤਰ ਲਈ ਪੁੱਛਦਾ ਹੈ, ਇੱਕ ਐਕਸੈਸ ਟੋਕਨ ਪ੍ਰਾਪਤ ਕਰਦਾ ਹੈ ਅਤੇ ਡਿਵਾਈਸਾਂ ਦੇ ਪਹਿਲੇ ਪੰਨੇ ਨੂੰ ਸੂਚੀਬੱਧ ਕਰਦਾ ਹੈ। ਟੋਕਨ ਨੂੰ ਨਿੱਜੀ ਰੱਖੋ। ਇਹ ਦਸਤਾਵੇਜ਼ੀ ਪੰਨੇ ਕਦੇ ਵੀ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਦੀ ਮੰਗ ਨਹੀਂ ਕਰਦੇ ਜਾਂ ਸਟੋਰ ਨਹੀਂ ਕਰਦੇ।
ਇੱਕ ਭਾਸ਼ਾ ਚੁਣੋ ਅਤੇ ਹੇਠਾਂ ਸੂਚੀਬੱਧ ਨਿਰਭਰਤਾਵਾਂ ਨੂੰ ਸਥਾਪਿਤ ਕਰੋ। ਉਦਾਹਰਣਾਂ ਕਲਾਉਡ 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 ਪੁਰਾਣੇ ਜਾਂ ਵੱਖਰੇ ਤੌਰ 'ਤੇ ਬਣਾਏ ਗਏ ਪ੍ਰਮਾਣ ਪੱਤਰਾਂ ਦਾ ਵਰਣਨ ਕਰਦੇ ਹਨ, ਪ੍ਰੀਸੈੱਟ ਨਾਮਾਂ ਦਾ ਨਹੀਂ।
| ਪ੍ਰੀਸੈੱਟ | ਚੁਣੀਆਂ ਗਈਆਂ ਸਮਰੱਥਾਵਾਂ |
|---|---|
| ਸਿਰਫ਼ ਵਸਤੂ ਸੂਚੀ | ਡਿਵਾਈਸ ਵਸਤੂ ਸੂਚੀ ਪੜ੍ਹੋ। |
| ਸਹਾਇਤਾ ਵੇਖੋ | ਵਸਤੂ ਪੜ੍ਹੋ ਅਤੇ ਸਕ੍ਰੀਨਾਂ ਵੇਖੋ। |
| ਇੰਟਰਐਕਟਿਵ ਸਹਾਇਤਾ | ਸਹਾਇਤਾ ਪਲੱਸ ਸਕ੍ਰੀਨ ਕੰਟਰੋਲ ਵੇਖੋ। |
| ਆਟੋਮੇਸ਼ਨ ਆਪਰੇਟਰ | ਸੂਚੀ, ਆਟੋਮੇਸ਼ਨ, ਰਿਪੋਰਟਾਂ ਅਤੇ ਪੈਚਿੰਗ ਪੜ੍ਹੋ; ਆਟੋਮੇਸ਼ਨ ਚਲਾਓ ਅਤੇ ਬੰਦ ਕਰੋ। |
| ਪੂਰੀ ਪਹੁੰਚ | ਸਾਰੀਆਂ ਮੌਜੂਦਾ ਸਮਰੱਥਾਵਾਂ। |
| ਕਸਟਮ ਅਨੁਮਤੀਆਂ | ਸਿਰਫ਼ ਉਹ ਸਮਰੱਥਾਵਾਂ ਜੋ ਤੁਸੀਂ ਚੁਣਦੇ ਹੋ। |
ਸੰਗਠਨ, ਕੰਪਨੀ ਅਤੇ ਸਾਈਟ
ਇੱਕ ਸੰਗਠਨ ਤੁਹਾਡੇ ਖਾਤੇ ਦੀ ਉੱਚ-ਪੱਧਰੀ ਸੀਮਾ ਹੈ। ਕੰਪਨੀਆਂ ਇਸ ਦੇ ਅੰਦਰ ਗਾਹਕਾਂ ਜਾਂ ਵਪਾਰਕ ਇਕਾਈਆਂ ਨੂੰ ਵੱਖ ਕਰਦੀਆਂ ਹਨ। ਕਿਸੇ ਕੰਪਨੀ ਦੇ ਅੰਦਰ ਸਾਈਟਾਂ ਗਰੁੱਪ ਡਿਵਾਈਸਾਂ। ਇੱਕ ਕੰਪਨੀ-ਸਕੋਪਡ ਪ੍ਰਮਾਣ ਪੱਤਰ ਕਿਸੇ ਹੋਰ ਕੰਪਨੀ ਦੇ ਡੇਟਾ ਤੱਕ ਪਹੁੰਚ ਨਹੀਂ ਕਰ ਸਕਦਾ ਹੈ।