RemotePC Enterprise API 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.
È possibile inviare le richieste API utilizzando la chiave API generata per il proprio account nella console web.
Per ottenere la chiave API,
- Accedere all'account RemotePC Enterprise.
- 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.
Nota: solo l'amministratore (proprietario dell'account) può generare la chiave API.
1. Invitare l'utente
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
string[]: email - Obbligatorio
int: status_2FA - Opzionale (i valori ammessi sono 0 e 1; 1 - stato ON e 0 - stato OFF)
Risposta Http
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione 1
{
"email": [
"shane@myworld"
]
}
Richiedi il campione 2
{
"email": [
"shane@myworld"
],
"status_2FA":1
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Campione di errore di risposta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descrizione può includere
FALLITO
ERRORE_SERVER_INTERNO
Utente non valido
Autorizzazione utente non valida
Piano utente non valido
Stato a due fattori non valido
2. Creare un utente
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa: nome - Obbligatorio
stringa: cognome - Obbligatorio
stringa: nome utente - Obbligatorio
stringa: password - Obbligatorio
int: status_2FA - Facoltativo (i valori ammessi sono 0 e 1; 1 - stato ON e 0 - stato OFF)
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Richiedi il campione 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
La descrizione può includere
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
First name cannot be blank
First name can contain a-z, A-Z and space
Last name cannot be blank
Last name can contain a-z, A-Z and space
Username/Email cannot be blank
Enter a valid Username/Email
Password cannot be blank
Password can contain A-Z, a-z, 0-9 and ~`!@#$%^&*()-_+={}|[];\'\"<>,.?/
Password should be between 6 - 20 characters
Email is already in use or already invited.
Email in use with other Admin
Invalid two factor status
3. Cancellare l'utente
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
string[]: sub_ids - Obbligatorio
string[]: invited_ids - Obbligatorio
sub_ids: ID e-mail degli utenti attivi,
invited_ids: ID e-mail degli utenti invitati
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
Richiedi il campione
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Campione di errore di risposta
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
La descrizione può includere
FALLITO
ERRORE_SERVER_INTERNO
Utente non valido
Autorizzazione utente non valida
Piano utente non valido
4. Ottenere gli utenti
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Tipo di metodo: GET
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
Int pageIndex - Opzionale
Int recordPerPage - Opzionale, il valore predefinito è 500
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"pageIndex": 1,
"recordPerPage": 30
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": {
"pagination": {
"records_per_page": 30,
"total_records": 1,
"total_page_count": 1,
"current_page_index": 1
}
"users": [
{
"firstname": "firstname",
"username": "shane@mymail",
"lastname": "lastname"
]
}
}
}
Campione di errore previsto
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descrizione può includere
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
Indice di pagina non valido
Nota: Il numero massimo di elenchi di utenti da richiedere in una sola volta è 500.
5. Assegnare il computer all'utente
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa: nome utente - Obbligatorio
string[]: computer_names - Obbligatorio
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descrizione può includere
Il nome utente è richiesto
I nomi dei computer non sono stati trovati nella richiesta
Utente non trovato
Computer non trovato
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
6. Disassegnare il computer all'utente
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa: nome utente - Obbligatorio
string[]: computer_names - Obbligatorio
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
La descrizione può includere
Il nome utente è richiesto
I nomi dei computer non sono stati trovati nella richiesta
Utente non trovato
Computer non trovato
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
7. Creare un gruppo e spostare i computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
stringa: nome_gruppo - Obbligatorio
string[]: nomi_computer - Facoltativo
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
La descrizione può includere
Il nome utente è richiesto
I nomi dei computer non sono stati trovati nella richiesta
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
Il nome del gruppo non può essere vuoto
Il nome del gruppo esiste già
Nome gruppo non valido
8. Rimuovere i computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta
string[]: nomi_computer - Obbligatorio
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
La descrizione può includere:
Utente non valido
I nomi dei computer non sono stati trovati nella richiesta
Superato il limite di computer
Computer non trovati
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
Nota: è possibile rimuovere solo i computer offline. È possibile rimuovere fino a 50 computer alla volta.
9. Aggiungi un commento per il computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta:
stringa: nome_computer - Obbligatorio
stringa: commento_desc - Obbligatorio
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
La descrizione può includere
Il nome utente è obbligatorio
Il nome del computer non può essere vuoto
I commenti non possono essere vuoti
La lunghezza dei commenti deve essere compresa tra 6 e 250
Computer non trovato
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
10. Ottenere i dispositivi
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Tipo di metodo: GET
Intestazioni della richiesta:
- Authorization: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta:
Int pageIndex - Opzionale
Int recordPerPage - Opzionale, il valore predefinito è 500
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"pageIndex": 1,
"recordPerPage": 30
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": {
"devices": [
{
"machine_id": "###################",
"host_name": "Computer A",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 11:07:11",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
{
"machine_id": "###################",
"host_name": "Computer B",
"host_os_version": "10.0",
"host_ip": "0.0.0.0",
"viewer_last_session_time": "2023-02-24 10:56:01",
"comments": "",
"host_os_text": "Windows",
"host_status_text": "Offline"
}
]
"pagination": {
"records_per_page": 30,
"total_records": 2,
"total_page_count": 1,
"current_page_index": 1
}
}
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
La descrizione può includere
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
Indice di pagina non valido
Nota: il numero massimo di elenchi di dispositivi da richiedere in una sola volta è 500.
11. Spostare i computer in un gruppo
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Tipo di metodo: POSTA
Intestazioni della richiesta:
- Authorization header: Bearer <api key>
- Tipo di contenuto: application/json
Richiesta:
stringa: nome_gruppo- Obbligatorio
stringa[]: nomi_computer- Obbligatorio
Risposta HTTP
200 (successo)
500 (errore del server)
400 (Parametri non validi)
401 (Non autorizzato)
403 (Richiesta non valida)
404 (Non trovato)
Richiedi il campione
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Campione di risposta
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Campione di errore di risposta
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Risposta di errore prevista
I nomi dei computer non sono stati trovati nella richiesta
Utente non valido
Autorizzazione utente non valida
ERRORE_SERVER_INTERNO
Piano utente non valido
Il nome del gruppo non può essere vuoto
Il nome del gruppo non esiste
Nome gruppo non valido