RemotePC API akceptuje żądania i zwraca odpowiedzi w formacie 'JSON'. Mechanizm uwierzytelniania za pomocą klucza API jest używany wraz z białą listą adresów IP do uwierzytelniania API. Dla wszystkich API klucz API musi być dodany w nagłówku autoryzacji.
Sprzedawcy mogą wysyłać żądania API za pomocą klucza API wygenerowanego dla ich konta w konsoli internetowej.
Aby uzyskać klucz API,
- Zaloguj się na swoje konto RemotePC Reseller.
- Idź do Moje konto tab i kliknij Klucze API.
- Kliknij Widok, wprowadź hasło do konta i kliknij Widok.
- Klucz API zostanie wyświetlony. Kliknij Kopiuj klucz skopiować do schowka.
Aby zmienić klucz API, kliknij Zmień. Wprowadź hasło do konta i kliknij Widok aby wyświetlić nowy klucz API.
1. Dodaj użytkownika
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string firstName;
string lastName;
string invitedUserEmailId;
string password;
integer allotedComputers; //optional parameter, default is 0
boolean sendEmailToUser; //email notification to user is an optional parameter
Kody odpowiedzi HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Poproś o próbkę
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Odpowiedź
Przykład udanej odpowiedzi
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "EMAIL_EXISTS"
}
]
}
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
Opis może zawierać:
- IMIĘ_WYMAGANE,
- NAZWISKO_WYMAGANE,
- WYMAGANY_EMAILID
- WPROWADŹ_PRAWIDŁOWY_ADRES_EMAIL
- WYMAGANE_HASŁO,
- NIEPRAWIDŁOWE_HASŁO
2. Zaproś użytkowników
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string invitedUserEmailId;
integer allotedComputers; //optional parameter, default is 0
Kody odpowiedzi HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Poproś o próbkę
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Przykład udanej odpowiedzi
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Przykład błędu odpowiedzi
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
{
"status": "Forbidden",
"code": 403,
"errorsCount": 1,
"errors": [
{
"description": "Forbidden "
}
]
}
3. Logowanie użytkownika
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Prośba
string username;
string password;
Kody odpowiedzi HTTP
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Poproś o próbkę
{
"username": "username",
"password": "password"
}
Odpowiedź
Przykład udanej odpowiedzi
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Uwaga: Użyj rpc_redirect_link, aby automatycznie zalogować się na konto.
Przykład błędu odpowiedzi
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "USERNAME_DOES_NOT_EXIST"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "ACTION_PARENT_ACCOUNT_SUSPENDED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "IP_ADDRESS_BLOCKED"
}
]
}
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "CANCELLED_ACCOUNT"
}
]
}
Opis może zawierać
WYMAGANY_EMAILID
NIEWAŻNY_EMAIL,
WYMAGANE_HASŁO,
WYMAGANA_NAZWA_UŻYTKOWNIKA
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
4. Lista użytkowników
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Kody odpowiedzi HTTP
200 (Success)
500 (Server Error)
401 (Unauthorized)
Odpowiedź
Przykład udanej odpowiedzi
{
"status": "OK",
"code": 200,
"message":{
"resellerUsersList": [
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 1,
"created_date": "01-13-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 0,
"created_date": "01-15-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
},
{
"alloted_computers": 425,
"created_date": "01-25-2023",
"isActive": true,
"utilized_computers": 0,
"username": "[email protected]"
}
]
}
}
Przykład błędu odpowiedzi
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}