L'API RemotePC accetta richieste e restituisce risposte in formato 'JSON'. Per l'autenticazione delle API viene utilizzato il meccanismo di autenticazione della chiave API insieme alla whitelist dell'IP. Per tutte le API, la chiave API deve essere aggiunta nell'intestazione di autorizzazione.
I rivenditori possono inviare le richieste API utilizzando la chiave API generata per il loro account nella console web.
Per ottenere la chiave API,
- Accedere al proprio account RemotePC Reseller.
- Andare alla scheda Il mio account e fare clic su Chiavi API.
- Fare clic su Visualizza, inserire la password dell'account e fare clic su Visualizza.
- Verrà visualizzata la chiave API. Fare clic su Copia chiave per copiare negli appunti.
Per modificare la chiave API, fare clic su Cambia. Inserire la password dell'account e fare clic su Visualizza per visualizzare la nuova chiave API.
1. Aggiungere l'utente
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/add
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa firstName;
stringa lastName;
stringa invitedUserEmailId;
stringa password;
intero allotedComputers; //parametro opzionale, il valore predefinito è 0
boolean sendEmailToUser; //la notifica via e-mail all'utente è un parametro opzionale
Codici di risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione
{
"firstName": "firstname",
"lastName": "lastname",
"invitedUserEmailId": "[email protected]",
"password": "password",
"allotedComputers": 1,
"sendEmailToUser": true
}
Risposta
Esempio di successo della risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"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 "
}
]
}
La descrizione può includere:
- NOME_RICHIESTO,
- COGNOME_RICHIESTO,
- EMAILID_REQUIRED,
- INSERIRE_EMAIL_VALIDO,
- PASSWORD_RICHIESTA,
- PASSWORD_NON_VALIDA
2. Invitare gli utenti
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/invite
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa invitedUserEmailId;
intero allotedComputers; //parametro facoltativo, il valore predefinito è 0
Codici di risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione
[
{
"invitedUserEmailId": "[email protected]",
"allotedComputers": 10
}
]
Esempio di successo della risposta
{
"status": "OK",
"code": 200,
"message": [
{
"username": "[email protected]",
"status": "ALREADY_INVITED"
},
{
"username": "[email protected]",
"status": "EXISTS"
},
{
"username": "[email protected]",
"status": "INVITED"
}
]
}
Campione di errore di risposta
{
"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. Accesso dell'utente
URL: https://web1.remotepc.com/rpc-api/reseller/private/user/signin
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa nome utente;
stringa password;
Codici di risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione
{
"username": "username",
"password": "password"
}
Risposta
Esempio di successo della risposta
{
"status": "OK",
"code": 200,
"message": {
"rpc_redirect_link":"https://login.remotepc.com/rpcnew/process/autologin/eyJhbGciOiJIUzUxMiJ9"
}
}
Nota: utilizzare rpc_redirect_link per effettuare il login automatico all'account.
Campione di errore di risposta
{
"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"
}
]
}
La descrizione può includere
EMAILID_REQUIRED,
INVALID_EMAIL,
PASSWORD_RICHIESTA,
NOME_UTENTE_RICHIESTO
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "NOT_AUTHORIZED"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
4. Elenco utenti
URL:https://web1.remotepc.com/rpc-api/reseller/private/user/list
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Codici di risposta HTTP
200 (successo)
500 (errore del server)
401 (Non autorizzato)
Risposta
Esempio di successo della risposta
{
"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]"
}
]
}
}
Campione di errore di risposta
{
"status": "UNAUTHORIZED",
"code": 401,
"errorsCount": 1,
"errors": [
{
"description": "UNAUTHORIZED_ACCCESS"
}
]
}
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}