RemotePC
    Inglês
    • Español
    • 日本語
    • Deutsche
    • Français
    • Italiano
    • Português
    • Português-BR
    • 한국어
    • Dutch
    • Turkish

    Menu

    • A minha conta
    • Login
    • Inscrever-se
    • Inglês
      • Español
      • 日本語
      • Deutsche
      • Français
      • Italiano
      • Português
      • Português-BR
      • 한국어
      • Dutch
      • Turkish
    • Características
    • Fixação de preços
    • Descarregar

    APIs de empresas

    • APIs de empresas
      • Convidar utilizadores
      • Criar utilizador
      • Eliminar utilizadores
      • Obter utilizadores
      • Atribuir computador
      • Desatribuir computador
      • Criar grupos e mover computadores
      • Remover computadores
      • Adicionar comentário para o computador
      • Obter dispositivos
      • Transferir computadores para um grupo

    RemotePC Enterprise API aceita pedidos e devolve respostas no formato 'JSON'. O mecanismo de autenticação da chave API é utilizado juntamente com a lista branca de IP para autenticar as APIs. Para todas as APIs, a Chave de API deve ser adicionada no cabeçalho da autorização.

    Pode enviar os pedidos API utilizando a Chave API gerada para a sua conta na consola web.
    Para obter a chave da API,

    1. Inicie a sessão na sua conta RemotePC Enterprise.
    2. Ir para o separador A minha conta e clicar nas teclas API.
    3. Clique em Ver, introduza a password da conta, e clique em Ver.
    4. A chave API será exibida. Clique em Copy Key para copiar para a área de transferência.

    Para alterar a chave API, clique em Change. Introduza a palavra-passe da conta e clique em Ver para ver a nova chave API.

    Nota: Apenas o Admin (dono da conta) pode gerar a chave API.

    1. Convidar utilizador

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                           string[]: email - Obrigatório
    int: status_2FA - Opcional (os valores permitidos são 0 e 1; 1 - Status ON & 0 - Status OFF)

    Resposta Http

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)

    Pedir amostra 1

                            {
     "email": [
      "[email protected]"
     ]
    }

    Pedir amostra 2

                            {
     "email": [
      "[email protected]"
     ],
     "status_2FA":1
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": {
       "invalid_list": [
        "[email protected]"
        ]
       "invited_list": [
        "[email protected]"
        ]
      }
    }

    Amostra de erro de resposta

                            {
      "status": "INTERNAL_SERVER_ERROR",
      "code": 500,
      "errorsCount": 1,
      "errors": [
       {
         "description": "INTERNAL_SERVER_ERROR"
       }
      ]
    }

    A descrição pode incluir

                            FALHADO
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Utilizador inválido
    Permissões de utilizador inválidas
    Plano de utilizador inválido
    Estatuto de dois factores inválidos

    2. Criar utilizador

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

     
                          Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string: primeiro nome - Obrigatório
    cordão: último nome - Obrigatório
    string: nome de utilizador - Obrigatório
    string: password - Obrigatório
    int: status_2FA - Opcional (os valores permitidos são 0 e 1; 1 - Status ON & 0 - Status OFF)

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)

    Pedir amostra 1

                               {
      "firstname": "firstname",
      "lastname": "lastname",
      "username": "[email protected]",
      "password": "password"
    }

    Pedir amostra 2

                               {
      "firstname": "firstname",
      "lastname": "lastname",
      "username": "[email protected]",
      "password": "password",
      "status_2FA":1
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Email is already in use or already invited."
        }
      ]
    }

    A descrição pode incluir

                            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 ~`[email protected]#$%^&*()-_+={}|[];\'\"<>,.?/
    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. Eliminar utilizador

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

     
                          Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string[]: sub_ids - Obrigatório
    string[]: invited_ids - Obrigatório
                            sub_ids: IDs de e-mail de utilizadores activos,
    convidados_ids: IDs de Email de Utilizador Convidado

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)

    Pedir amostra

                            {
      "sub_ids":[
       "[email protected]",
       "[email protected]",
       "[email protected]"
      ],
      "invited_ids":[
        "[email protected]"
      ],
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": {
       "active_user_delete_status": {
        "[email protected]": "FAILED"
       },
        "invited_user_delete_status": {
        "[email protected]": "SUCCESS"
        }
      }
    }

    Amostra de erro de resposta

                            {
      "status": "INTERNAL_SERVER_ERROR",
      "code": 500,
      "errorsCount": 1,
      "errors": [
       {
        "description": "INTERNAL_SERVER_ERROR"
        }
      ]
    }

    A descrição pode incluir

                            FALHADO
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Utilizador inválido
    Permissões de utilizador inválidas
    Plano de utilizador inválido

    4. Obter utilizadores

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

     
                            Método-Tipo: GET
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            Int pageIndex - Opcional
    Int recordPerPage - Opcional, o valor por defeito é 500

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "pageIndex": 1,
      "recordPerPage": 30
    }

    Amostra de resposta

                            {
      "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": "[email protected]",
          "lastname": "lastname"
         ]
       }
      }
    }

    Amostra de erro esperada

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Invalid page index"
        }
      ]
    }

    A descrição pode incluir

                            Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido
    Índice de página inválido

    Nota: O número máximo de listas de utilizadores a solicitar de uma só vez é de 500.

    5. Atribuir o computador ao utilizador

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string: nome de utilizador - Obrigatório
    string[]: nomes_do_computador - Obrigatório

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "username": "[email protected]",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer name can not be blank"
        }
      ]
    }

    A descrição pode incluir

                            O nome de utilizador é obrigatório
    Os nomes dos computadores não são encontrados no pedido
    Utilizador não encontrado
    Computador(es) não encontrado(s)
    Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido

    6. Desatribuir o computador ao utilizador

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string: nome de utilizador - Obrigatório
    string[]: nomes_do_computador - Obrigatório

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "username": "[email protected]",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer names are not found in the request"
        }
      ]
    }

    A descrição pode incluir

                            O nome de utilizador é obrigatório
    Os nomes dos computadores não são encontrados no pedido
    Utilizador não encontrado
    Computador(es) não encontrado(s)
    Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido

    7. Criar grupos e mover computadores

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string: nome_grupo - Obrigatório
    string[]: nomes_do_computador - Opcional

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "group_name": "Group A",
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Group name is already exists"
        }
      ]
    }

    A descrição pode incluir

                            O nome de utilizador é obrigatório
    Os nomes dos computadores não são encontrados no pedido
    Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido
    O nome do grupo não pode estar em branco
    O nome do grupo já existe
    Nome do grupo inválido

    8. Remover computador(es)

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido

                            string[]: nomes_do_computador - Obrigatório

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "computer_names": [
       "Computer A",
       "Computer B"
      ],
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer names are not found in the request"
        }
      ]
    }

    A descrição pode incluir:

                            Utilizador inválido
    Os nomes dos computadores não são encontrados no pedido
    Ultrapassou o limite de computadores
    Computador(es) não encontrado(s)
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido

    Nota: Apenas os computadores off-line podem ser removidos. De cada vez, até 50 computadores podem ser removidos.

    9. Adicionar comentário para computador

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido:

                            string: nome_do_computador - Obrigatório
    string: comment_desc - Obrigatório

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
       "comment_desc": "This is my computer",
      "computer_name": "Computer A"
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Computer name can not be blank"
        }
      ]
    }

    A descrição pode incluir

                            O nome de utilizador é obrigatório
    O nome do computador não pode estar em branco
    Os comentários não podem estar em branco
    O comprimento dos comentários deve ser entre 6 e 250
    Computador não encontrado
    Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido

    10. Obter dispositivos

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

     
                            Método-Tipo: GET
    Pedir cabeçalhos:
    • Authorization: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido:

                            Int pageIndex - Opcional
    Int recordPerPage - Opcional, o valor por defeito é 500

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "pageIndex": 1,
      "recordPerPage": 30
    }

    Amostra de resposta

                            {
      "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
        }
      }
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
       {
        "description": "Invalid page index"
        }
      ]
    }

    A descrição pode incluir

                            Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido
    Índice de página inválido

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

    11. Mover computadores para um grupo

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

     
                            Método-Tipo: LUGAR
    Pedir cabeçalhos:
    • Authorization header: Bearer <api key>
    • Tipo de conteúdo: aplicação/json

    Pedido:

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

    Resposta HTTP

                            200 (Sucesso)
    500 (Erro do Servidor)
    400 (Parâmetros inválidos)
    401 (Não Autorizado)
    403 (Pedido inválido)
    404 (Não encontrado)

    Pedir amostra

                            {
      "group_name": "Group A",
      "computer_names": [
        "Computer A",
        "Computer B"
      ]
    }

    Amostra de resposta

                            {
      "status": "OK",
      "code": 200,
      "message": "SUCCESS"
    }

    Amostra de erro de resposta

                            {
      "status": "BAD_REQUEST",
      "code": 400,
      "errorsCount": 1,
      "errors": [
        {
          "description": "Group name does not exists"
        }
      ]
    }

    Resposta de erro esperada

                            Os nomes dos computadores não são encontrados no pedido
    Utilizador inválido
    Permissões de utilizador inválidas
    INTERNO_SERVIDOR_ERVIDOR_ERRO
    Plano de utilizador inválido
    O nome do grupo não pode estar em branco
    O nome do grupo não existe
    Nome do grupo inválido
    • RemotePC™

    • Características
    • Fixação de preços
    • Equipa
    • Empresa
    • Acesso via Web
    • Acesso através do telemóvel
    • Empresa
    • Comece a trabalhar

    • Descarregar
    • Inscrição
    • FAQs
    • Tutoriais em vídeo
    • Serviços

    • Parceiros
    • Conformidade
    • Legal

    • Termos de Serviço
    • Política de Privacidade
    • Política de Utilização Aceitável

    Apoio


    © IDrive Inc.