RemotePC Enterprise API accepteert verzoeken en geeft antwoorden terug in het 'JSON'-formaat. Het API-sleutel authenticatiemechanisme wordt gebruikt samen met IP-whitelisting om de API's te authenticeren. Voor alle API's moet de API-sleutel worden toegevoegd in de autorisatie-header.
Je kunt de API-verzoeken verzenden met de API-sleutel die voor je account in de webconsole is gegenereerd.
Om de API-sleutel te krijgen,
- Log in op je RemotePC Zakelijke account.
- Ga naar Mijn account tab en klik API-sleutels.
- Klik Bekijken, voer het accountwachtwoord in en klik Bekijken.
- De API-sleutel wordt weergegeven. Klik Kopieer sleutel om naar het klembord te kopiëren
Om de API-sleutel te wijzigen, klik Veranderen. Voer het accountwachtwoord in en klik Bekijken om de nieuwe API-sleutel te bekijken.
Opmerking: Alleen de beheerder (accounteigenaar) kan de API-sleutel genereren.
1. Nodig gebruiker uit
URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string[]: email - Mandatory
int: status_2FA - Optional (allowed values are 0 and 1; 1 - Status ON & 0 - Status OFF)
int: sso_flag - Optional (allowed values are 0 and 1; 1 - Enable SSO & 0 - Disable SSO)
Opmerking: SSO moet eerst op het beheerdersaccount worden geconfigureerd om het voor gebruikers in te schakelen. Als SSO niet is ingesteld op het beheerdersaccount, kan het niet voor een gebruiker worden ingeschakeld.
Http-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Vraagmonster 1
{
"email": [
"shane@myworld"
]
}
Vraagmonster 2
{
"email": [
"shane@myworld"
],
"status_2FA":1,
"sso_flag":1
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": {
"invalid_list": [
"shane@myworld"
]
"invited_list": [
"shane@myworld"
]
}
}
Voorbeeld van respondfout
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Beschrijving kan omvatten
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status
2. Gebruiker aanmaken
URL: https://web1.remotepc.com/rpcnew/api/msp/user/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string: firstname - Mandatory
string: lastname - Mandatory
string: username - Mandatory
string: password - Mandatory
int: status_2FA - Optional (allowed values are 0 and 1; 1 - Status ON & 0 - Status OFF)
int: sso_flag - Optional (allowed values are 0 and 1; 1 - Enable SSO & 0 - Disable SSO)
Opmerking: SSO moet eerst op het beheerdersaccount worden geconfigureerd om het voor gebruikers in te schakelen. Als SSO niet is ingesteld op het beheerdersaccount, kan het niet voor een gebruiker worden ingeschakeld.
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Vraagmonster 1
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password"
}
Vraagmonster 2
{
"firstname": "firstname",
"lastname": "lastname",
"username": "shane@myworld",
"password": "password",
"status_2FA":1,
"sso_flag":1
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Email is already in use or already invited."
}
]
}
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
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string[]: sub_ids - Mandatory
string[]: invited_ids - Mandatory
sub_ids: Active User Email IDs,
invited_ids: Invited User Email IDs
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
Vraag een monster aan
{
"sub_ids":[
"diane@myworld",
"pam@myworld",
"bill@myworld"
],
"invited_ids":[
"jamie@myworld"
],
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": {
"active_user_delete_status": {
"carol@myworld": "FAILED"
},
"invited_user_delete_status": {
"aaron@myworld": "SUCCESS"
}
}
}
Voorbeeld van respondfout
{
"status": "INTERNAL_SERVER_ERROR",
"code": 500,
"errorsCount": 1,
"errors": [
{
"description": "INTERNAL_SERVER_ERROR"
}
]
}
Beschrijving kan omvatten
FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
4. Gebruikers ophalen
URL: https://web1.remotepc.com/rpcnew/api/msp/user/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwoordvoorbeeld
{
"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 foutvoorbeeld
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschrijving kan omvatten
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notitie: Het maximum aantal gebruikerslijsten dat tegelijk kan worden opgevraagd is 500.
5. Wijs de computer toe aan de gebruiker
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string: username - Mandatory
string[]: computer_names - Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Beschrijving kan omvatten
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
6. Wijs de computer niet meer toe aan de gebruiker
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string: username - Mandatory
string[]: computer_names - Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"username": "shane@myworld",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Beschrijving kan omvatten
Username is required
Computer names are not found in the request
User not found
Computer(s) not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
7. Maak groep aan en verplaats computers
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string: group_name - Mandatory
string[]: computer_names - Optional
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name is already exists"
}
]
}
Beschrijving kan omvatten
Username is required
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name is already exists
Invalid group name
8. Verwijder computer(s)
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek
string[]: computer_names - Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"computer_names": [
"Computer A",
"Computer B"
],
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer names are not found in the request"
}
]
}
Beschrijving kan bevatten:
Invalid user
Computer names are not found in the request
Exceeded computers limit
Computer(s) not found
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Notitie: Alleen offline computers kunnen worden verwijderd. Tegelijkertijd kunnen maximaal 50 computers worden verwijderd.
9. Voeg commentaar toe voor computer
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add
Method-Type: POST
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek:
string: computer_name - Mandatory
string: comment_desc - Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"comment_desc": "This is my computer",
"computer_name": "Computer A"
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Computer name can not be blank"
}
]
}
Beschrijving kan omvatten
Username is required
Computer name can not be blank
Comments can not be blank
Comments length should be between 6 to 250
Computer not found
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
10. Apparaten ophalen
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"pageIndex": 1,
"recordPerPage": 30
}
Antwoordvoorbeeld
{
"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
}
}
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschrijving kan omvatten
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notitie: Het maximum aantal apparaatlijsten dat tegelijk kan worden opgevraagd is 500.
11. Verkrijg gebruikersapparaten
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}
Method-Type: GET
Request headers:
- Authorization: Bearer <api key>
- Content-type: application/json
Verzoek:
Int pageIndex - Optional
Int recordPerPage - Optional, Default is 500
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"pageIndex": 1,
"recordPerPage": 30,
}
Antwoordvoorbeeld
{
"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
}
}
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid page index"
}
]
}
Beschrijving kan omvatten
Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index
Notitie: Het maximum aantal apparaatlijsten dat tegelijk kan worden opgevraagd is 500.
12. Verplaats computers naar een groep
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/move
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Verzoek:
string: group_name- Mandatory
string[]: computer_names- Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"group_name": "Group A",
"computer_names": [
"Computer A",
"Computer B"
]
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "SUCCESS"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Group name does not exists"
}
]
}
Verwachte foutreactie
Computer names are not found in the request
Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Group name can not be blank
Group name does not exists
Invalid group name
13. Verkrijg Web Viewer-verbinding URL
URL: https://web1.remotepc.com/rpcnew/api/msp/computer/get/connectUrl
Method-Type: POST
Request headers:
- Authorization header: Bearer <api key>
- Content-type: application/json
Verzoek:
string: machine_id - Mandatory
string: username - Mandatory
HTTP-respons
200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)
Vraag een monster aan
{
"username": "abc@xyz",
"machine_id": "GVHR654GBUYJH"
}
Antwoordvoorbeeld
{
"status": "OK",
"code": 200,
"message": "https://login.remotepc.com/rpcnew/viewer/redirect/msp/connect/process/abc"
}
Voorbeeld van respondfout
{
"status": "BAD_REQUEST",
"code": 400,
"errorsCount": 1,
"errors": [
{
"description": "Invalid machine_id"
}
]
}
Beschrijving kan omvatten
Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username