RemotePC™ - Enterprise APIs

A API Enterprise do RemotePC aceita solicitações e retorna respostas no formato 'JSON'. O mecanismo de autenticação por chave de API é usado junto com a lista de permissões de IP para autenticar as APIs. Para todas as APIs, a chave de API deve ser adicionada no cabeçalho de autorização.

Você pode enviar as solicitações de API usando a chave de API gerada para sua conta no console web.
Para obter a chave de API:

Faça login na sua conta RemotePC Enterprise.
Acesse a aba My Account e clique em API Keys.
Clique em View, insira a senha da conta e clique em View.
A chave de API será exibida. Clique em Copy Key para copiar para a área de transferência.

Para alterar a chave de API, clique em Change. Insira a senha da conta e clique em View para ver a nova chave de API.

Nota: Somente o administrador (proprietário da conta) pode gerar a chave de API.

1. Convidar usuários

URL: https://web1.remotepc.com/rpcnew/api/msp/user/invite

 
            Method-Type: POST

            Request headers:

            
              Authorization: Bearer <api key>
              Content-type: application/json

Solicitação

           string[]: email - Obrigatório

           int: status_2FA - Opcional (valores permitidos são 0 e 1; 1 - Status ATIVO & 0 - Status INATIVO)

           int: sso_flag - Opcional (valores permitidos são 0 e 1; 1 - Ativar SSO & 0 - Desativar SSO)

Nota: SSO deve ser configurado primeiro na conta do administrador para habilitá-lo para os usuários. Se SSO não estiver configurado na conta do administrador, ele não poderá ser habilitado para nenhum usuário.

Resposta Http

            200 (Success)

            500 (Server Error)

            400 (Invalid Parameters)

            401 (Unauthorized)

            403 (Invalid request)

Exemplo de solicitação 1

            {

               "email": [

                    "shane@myworld"

               ]

          }

Exemplo de solicitação 2

            {

               "email": ["shane@myworld"],

               "status_2FA":1,

               "sso_flag":1

          }

A descrição pode incluir

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
Invalid two factor status

2. Criar usuário

URL: https://web1.remotepc.com/rpcnew/api/msp/user/create

 
          Method-Type: POST

          Request headers:

          Authorization: Bearer <api key>
Content-type: application/json

Solicitação

            string: firstname - Obrigatório

            string: lastname - Obrigatório

            string: username - Obrigatório

            string: password - Obrigatório

            int: status_2FA - Opcional

            int: sso_flag - Opcional

Nota: SSO deve ser configurado primeiro na conta do administrador para habilitá-lo para os usuários.

A descrição pode incluir

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan
First name cannot be blank
Last name cannot be blank
Username/Email cannot be blank
Email is already in use or already invited.
Invalid two factor status

3. Excluir usuários

URL: https://web1.remotepc.com/rpcnew/api/msp/user/delete

 
          Method-Type: POST

          Request headers:

          Authorization: Bearer <api key>
Content-type: application/json

Solicitação

            string[]: sub_ids - Obrigatório

            string[]: invited_ids - Obrigatório

            sub_ids: IDs de e-mail de usuários ativos,

            invited_ids: IDs de e-mail de usuários convidados

A descrição pode incluir

FAILED
INTERNAL_SERVER_ERROR
Invalid user
Invalid user permission
Invalid user plan

4. Obter usuários

URL: https://web1.remotepc.com/rpcnew/api/msp/user/list

 
            Method-Type: GET

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação

Int pageIndex - Opcional
Int recordPerPage - Opcional, Padrão é 500

Resposta HTTP

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)
404 (Not Found)

A descrição pode incluir

Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: O número máximo de listas de usuários para solicitar de uma vez é 500.

5. Atribuir computador ao usuário

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/assign

 
            Method-Type: POST

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação

string: username - Obrigatório
string[]: computer_names - Obrigatório

A descrição pode incluir

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. Remover atribuição de computador ao usuário

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/unassign

 
            Method-Type: POST

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação

string: username - Obrigatório
string[]: computer_names - Obrigatório

A descrição pode incluir

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. Criar grupo e mover computadores

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/group/create

 
            Method-Type: POST

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação

string: group_name - Obrigatório
string[]: computer_names - Opcional

A descrição pode incluir

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. Remover computadores

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/remove

 
            Method-Type: POST

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação

string[]: computer_names - Obrigatório

A descrição pode incluir:

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

Nota: Somente computadores offline podem ser removidos. Por vez, até 50 computadores podem ser removidos.

9. Adicionar comentário para o computador

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/comments/add

 
            Method-Type: POST

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação:

string: computer_name - Obrigatório
string: comment_desc - Obrigatório

A descrição pode incluir

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. Obter dispositivos

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list

 
            Method-Type: GET

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação:

Int pageIndex - Opcional
Int recordPerPage - Opcional, Padrão é 500

A descrição pode incluir

Invalid user
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: O número máximo de listas de dispositivos para solicitar de uma vez é 500.

11. Obter dispositivos de usuários

URL: https://web1.remotepc.com/rpcnew/api/msp/computer/list/{username}

 
            Method-Type: GET

            Request headers:

            Authorization: Bearer <api key>
Content-type: application/json

Solicitação:

Int pageIndex - Opcional
Int recordPerPage - Opcional, Padrão é 500

A descrição pode incluir

Invalid user
Invalid username
Invalid user permission
INTERNAL_SERVER_ERROR
Invalid user plan
Invalid page index

Nota: O número máximo de listas de dispositivos para solicitar de uma vez é 500.

12. Mover computadores para um grupo

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

Solicitação:

string: group_name - Obrigatório
string[]: computer_names - Obrigatório

Resposta de erro esperada

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. Obter URL de conexão do Web Viewer

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

Solicitação:

string: machine_id - Obrigatório
string: username - Obrigatório

A descrição pode incluir

Invalid user
Invalid machine_id
Invalid username
invalid host_machine_id or username

RemotePC™ Enterprise APIs

1. Convidar usuários

2. Criar usuário

3. Excluir usuários

4. Obter usuários

5. Atribuir computador ao usuário

6. Remover atribuição de computador ao usuário

7. Criar grupo e mover computadores

8. Remover computadores

9. Adicionar comentário para o computador

10. Obter dispositivos

11. Obter dispositivos de usuários

12. Mover computadores para um grupo

13. Obter URL de conexão do Web Viewer

RemotePC^™ Enterprise APIs