RemotePC Enterprise API accepteert verzoeken en retourneert antwoorden in JSON formaat. Het API Key Authentication mechanisme wordt gebruikt samen met IP whitelisting om de API's te authenticeren. Voor alle API's moet de API Key worden toegevoegd in de autorisatie header.
U kunt de API-verzoeken versturen met de API-sleutel die voor uw account is gegenereerd in de webconsole.
Om de API sleutel te verkrijgen,
- Log in op uw RemotePC Enterprise account.
- Ga naar de tab Mijn Account en klik op API Keys.
- Klik op Bekijken, voer het wachtwoord van de account in en klik op Bekijken.
- De API Sleutel wordt weergegeven. Klik op Sleutel kopiëren om naar het klembord te kopiëren.
Klik op Wijzigen om de API-sleutel te wijzigen. Voer het accountwachtwoord in en klik op Bekijken om de nieuwe API-sleutel te bekijken.
Opmerking: Alleen de Admin (accounteigenaar) kan de API Sleutel genereren.
1. Gebruiker uitnodigen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string[]: email - Verplicht
int: status_2FA - Optioneel (toegestane waarden zijn 0 en 1; 1 - status AAN & 0 - status UIT)
Http antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (ongeldig verzoek)
Voorbeeld 1 aanvragen
{
"email": [
"shane@myworld"
]
}
Voorbeeld 2 aanvragen
{
"email": [
"shane@myworld"
],
"status_2FA":1
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Responsfoutenmonster
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
De beschrijving kan omvatten
FAILED
INTERNE_SERVER_FOUT
Ongeldige gebruiker
Ongeldige gebruikersrechten
Ongeldig gebruikersplan
Ongeldige twee factor status
2. Gebruiker aanmaken
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string: voornaam - Verplicht
string: achternaam - Verplicht
string: gebruikersnaam - Verplicht
string: wachtwoord - Verplicht
int: status_2FA - Optioneel (toegestane waarden zijn 0 en 1; 1 - Status ON & 0 - Status OFF)
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (ongeldig verzoek)
Voorbeeld 1 aanvragen
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Voorbeeld 2 aanvragen
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
De beschrijving kan omvatten
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. Gebruiker verwijderen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string[]: sub_ids - Verplicht
string[]: invited_ids - Verplicht
sub_ids: Active User Email ID's,
invited_ids: Invited User Email IDs
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (ongeldig verzoek)
Voorbeeld aanvragen
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Responsfoutenmonster
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
De beschrijving kan omvatten
FAILED
INTERNE_SERVER_FOUT
Ongeldige gebruiker
Ongeldige gebruikersrechten
Ongeldig gebruikersplan
4. Krijg gebruikers
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Methode-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
Int pageIndex - Optioneel
Int recordPerPage - Optioneel, standaard is 500
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwoordmonster
{
"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"
]
}
}
}
Verwachte foutmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
De beschrijving kan omvatten
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
Ongeldige pagina-index
Opmerking: Het maximum aantal gebruikerslijsten dat in één keer kan worden opgevraagd is 500.
5. Computer toewijzen aan de gebruiker
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string: gebruikersnaam - Verplicht
string[]: computer_namen - Verplicht
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
De beschrijving kan omvatten
Gebruikersnaam is vereist
Computernamen worden niet gevonden in het verzoek
Gebruiker niet gevonden
Computer(s) niet gevonden
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
6. Computer aan de gebruiker toewijzen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string: gebruikersnaam - Verplicht
string[]: computer_namen - Verplicht
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
De beschrijving kan omvatten
Gebruikersnaam is vereist
Computernamen worden niet gevonden in het verzoek
Gebruiker niet gevonden
Computer(s) niet gevonden
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
7. Groep aanmaken en computers verplaatsen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string: group_name - Verplicht
string[]: computer_namen - Facultatief
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
De beschrijving kan omvatten
Gebruikersnaam is vereist
Computernamen worden niet gevonden in het verzoek
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
Groepsnaam kan niet leeg zijn
Groepsnaam bestaat al
Ongeldige groepsnaam
8. Verwijder computer(s)
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek
string[]: computer_namen - Verplicht
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
De beschrijving kan omvatten:
Ongeldige gebruiker
Computernamen worden niet gevonden in het verzoek
Computerlimiet overschreden
Computer(s) niet gevonden
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
Opmerking: Alleen offline computers kunnen worden verwijderd. Per keer kunnen maximaal 50 computers worden verwijderd.
9. Opmerking toevoegen voor computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Methode-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek:
string: computer_name - Verplicht
string: comment_desc - Verplicht
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
De beschrijving kan omvatten
Gebruikersnaam is verplicht
Computernaam kan niet leeg zijn
Commentaar mag niet leeg zijn
De lengte van de opmerkingen moet tussen 6 en 250 zijn
Computer niet gevonden
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
10. Ontvang apparaten
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Methode-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek:
Int pageIndex - Optioneel
Int recordPerPage - Optioneel, standaard is 500
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwoordmonster
{
"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
}
}
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
De beschrijving kan omvatten
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
Ongeldige pagina-index
Opmerking: Het maximum aantal apparaatlijsten dat in één keer kan worden opgevraagd is 500.
11. Verplaats computers naar een groep
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Methode-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Inhoudstype: toepassing/json
Verzoek:
string: group_name- Verplicht
string[]: computer_namen- Verplicht
HTTP antwoord
200 (succes)
500 (Serverfout)
400 (ongeldige parameters)
401 (onbevoegd)
403 (Ongeldig verzoek)
404 (Niet gevonden)
Voorbeeld aanvragen
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Antwoordmonster
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Responsfoutenmonster
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Verwachte foutmelding
Computernamen worden niet gevonden in het verzoek
Ongeldige gebruiker
Ongeldige gebruikersrechten
INTERNE_SERVER_FOUT
Ongeldig gebruikersplan
Groepsnaam kan niet leeg zijn
Groepsnaam bestaat niet
Ongeldige groepsnaam